Feel++
0.91.4
|
Initialize, finalize, and query the Feel++ environment. More...
#include <environment.hpp>
Public Member Functions | |
Constructors, destructor | |
Environment () | |
Environment (int &argc, char **&argv) | |
~Environment () | |
Static Public Member Functions | |
Accessors | |
static bool | initialized () |
static bool | finalized () |
Methods | |
static std::string | rootRepository () |
static std::string | localGeoRepository () |
static boost::tuple < std::string, bool > | systemGeoRepository () |
static std::string | localConfigRepository () |
static boost::tuple < std::string, bool > | systemConfigRepository () |
static void | changeRepository (boost::format fmt, std::string const &="logfile") |
change the directory where the results are stored | |
static po::variables_map | vm (po::options_description const &desc) |
get variables_map from options_description desc | |
static void | setLogs (std::string const &prefix) |
Initialize, finalize, and query the Feel++ environment.
The Environment
class is used to initialize, finalize, and query the Feel++ environment. It will typically be used in the main()
function of a program, which will create a single instance of Environment
initialized with the arguments passed to the program:
int main(int argc, char* argv[]) { Feel::Environment env(argc, argv); }
The instance of Environment
will initialize Feel++ (by calling MPI
, PETSc
, SLEPc
and MAdLib
initialization routines) in its constructor and finalize in its destructor.
Feel::Environment::Environment | ( | int & | argc, |
char **& | argv | ||
) |
Shuts down the Feel environment.
If this Environment
object was used to initialize the Feel environment, and the Feel environment has not already been shut down (finalized), this destructor will shut down the Feel environment.
bool Feel::Environment::finalized | ( | ) | [static] |
Determine if the MPI environment has already been finalized.
The routine is equivalent to a call to MPI_Finalized
.
true
if the MPI environment has been finalized. bool Feel::Environment::initialized | ( | ) | [static] |
Determine if the MPI environment has already been initialized.
This routine is equivalent to a call to MPI_Initialized
.
true
if the MPI environment has been initialized. std::string Feel::Environment::localConfigRepository | ( | ) | [static] |
$HOME/feel/config
) References rootRepository().
Referenced by Feel::Application::doOptions().
std::string Feel::Environment::localGeoRepository | ( | ) | [static] |
$HOME/feel/geo
) References rootRepository().
Referenced by Feel::BOOST_PARAMETER_FUNCTION().
std::string Feel::Environment::rootRepository | ( | ) | [static] |
$HOME/feel
) Referenced by changeRepository(), localConfigRepository(), and localGeoRepository().
void Feel::Environment::setLogs | ( | std::string const & | prefix | ) | [static] |
boost::tuple< std::string, bool > Feel::Environment::systemConfigRepository | ( | ) | [static] |
/usr/share/feel/config
or /usr/local/share/feel/config) and true or false whether the directory exists or not Referenced by Feel::Application::doOptions().
boost::tuple< std::string, bool > Feel::Environment::systemGeoRepository | ( | ) | [static] |
/usr/share/feel/geo
or /usr/local/share/feel/geo) and true or false whether the directory exists or not Referenced by Feel::BOOST_PARAMETER_FUNCTION().