ASL  0.1.7
Advanced Simulation Library
Public Member Functions | List of all members
asl::ApplicationParametersManager Class Reference

#include <aslParametersManager.h>

Inheritance diagram for asl::ApplicationParametersManager:
Inheritance graph
[legend]
Collaboration diagram for asl::ApplicationParametersManager:
Collaboration graph
[legend]

Public Member Functions

 ApplicationParametersManager (const char *applicationName_, const char *applicationVersion_)
 
void load (int argc, char *argv[])
 
- Public Member Functions inherited from asl::ParametersManager
 ParametersManager ()
 
 ~ParametersManager ()
 
void enable ()
 Enables parameter loader. More...
 
template<typename T >
void add (UValue< T > parameter, const char *key, const char *description, const char *units)
 Adds a Parameter to ParametersManager. More...
 
template<typename T >
void add (UValue< std::map< std::string, T >> parameter, const char *key, const char *description, const char *units)
 Adds a group of parameters with common prefix to ParametersManager. More...
 
template<typename T >
void add (UValue< T > parameter, T defaultValue, const char *key, const char *description, const char *units)
 Adds a Parameter with a default value to ParametersManager. More...
 
template<typename T >
void addPrefix (const std::string prefix, std::shared_ptr< std::map< std::string, T >> destinationMap)
 
void load (std::string paramFile)
 
std::string getDir ()
 

Additional Inherited Members

- Static Public Attributes inherited from asl::ParametersManager
static ParametersManagercurrent
 
- Protected Member Functions inherited from asl::ParametersManager
void populateMaps (boost::program_options::variables_map &vm)
 
void writeParametersFile (const std::string fileName)
 
- Protected Attributes inherited from asl::ParametersManager
boost::program_options::options_description parametersOptions
 
std::string parametersFileDirectory
 
std::vector< std::shared_ptr< PrefixStore > > prefixes
 
std::string parametersFileStr
 Content of the parameters file. More...
 

Detailed Description

This class inherits ParametersManager class and thus also automatically accomodates newly created Parameters and then can load them from a parameters file and/or command line. It silently includes two parameters - platform and device that determine the hardware the application will run on. It has to be declared before declaring all the parameters it will manage!

Examples
acousticWaves.cc, bus_wind.cc, compressor.cc, cubeGravity.cc, cubeIncompressibleGravity.cc, cubePoroelasticGravity.cc, flow.cc, flow2.cc, flow3.cc, flowKDPGrowth.cc, flowRotatingCylinders.cc, jumpingBox.cc, levelSetBasic.cc, levelSetFacetedGrowth.cc, levelSetNormalGrowth.cc, locomotive.cc, locomotive_laminar.cc, locomotive_stability.cc, multicomponent_flow.cc, multiphase_flow.cc, pitot_tube_ice.cc, poroelastic.cc, surfaceFlux.cc, testSMDiff.cc, testSMDiff3C.cc, testSMPhi.cc, and testSMPhiBV.cc.

Definition at line 158 of file aslParametersManager.h.

Constructor & Destructor Documentation

◆ ApplicationParametersManager()

asl::ApplicationParametersManager::ApplicationParametersManager ( const char *  applicationName_,
const char *  applicationVersion_ 
)

Member Function Documentation

◆ load()

void asl::ApplicationParametersManager::load ( int  argc,
char *  argv[] 
)

The documentation for this class was generated from the following file: