Microflow 3D
v1.0
|
The ConfigData class provides accessors for text parser objects: case parameters, program parameters and thread parameters. More...
#include <ConfigData.h>
Public Member Functions | |
ConfigData (const char *pPathToProgramConfigFile, const char *pPathToCaseFolder, const char *pScope, bool verbose) | |
~ConfigData () | |
std::shared_ptr< MF::Parser::TextParser > | getTextParser_Ptr () |
config4cpp::Configuration * | getProgramParametres_Ptr () |
Returns pointer to text parser object. More... | |
config4cpp::Configuration * | getCaseParametres_Ptr () |
Returns pointer to program parameters parser object. More... | |
config4cpp::Configuration * | getThreadParametres_Ptr () |
Returns pointer to case parameters parser object. More... | |
int | getCaseParamLength (const char *parameterName) |
float | getCaseFloatParam (const char *parameterName) |
Returns number of case parameter of name "parameterName" > 0 if parameter exists. More... | |
int | getCaseIntParam (const char *parameterName) |
Returns case parameter of float type. More... | |
bool | getCaseBooleanParam (const char *parameterName) |
Returns case parameter of int type. More... | |
std::string | getCaseStringParam (const char *parameterName) |
Returns case parameter of boolean type. More... | |
float | getCaseFloatVectorParam (const int component, const char *parameterName) |
Returns case parameter of string type. More... | |
int | getCaseIntVectorParam (const int component, const char *parameterName) |
Returns case parameter of vector component of float type. More... | |
int | getGeometryDefinition () |
Returns case parameter of vector X component of int type. More... | |
int | getFlowType () |
Returns the way of GeometryDefinition of enum type: 0 - FromSTL. More... | |
int | getModelType () |
Returns the FlowType parameter of enum type: 0 - quasi compressible, 1 - incompressible Zou et al. 1995. More... | |
int | getLatticeType () |
Returns the ModelType parameter of enum type: 0 - BGK, 1 - MRT, 2 - FBGK, 3- MRT2. More... | |
int | getProgramParamLength (const char *parameterName) |
Returns the LatticeType parameter of enum type: 0 - D3Q19. More... | |
float | getProgramFloatParam (const char *parameterName) |
Returns number of program parameter of name "parameterName" > 0 if parameter exists. More... | |
int | getProgramIntParam (const char *parameterName) |
Returns program parameter of float type. More... | |
bool | getProgramBooleanParam (const char *parameterName) |
Returns program parameter of int type. More... | |
std::string | getProgramStringParam (const char *parameterName) |
Returns program parameter of boolean type. More... | |
float | getProgramFloatVectorParam (const int component, const char *parameterName) |
Returns program parameter of string type. More... | |
int | getProgramIntVectorParam (const int component, const char *parameterName) |
Returns program parameter of vector component of float type. More... | |
int | getThreadsNumber () |
Returns program parameter of vector component of int type. More... | |
int | getThreadParamLength (const int ThreadNr, const char *parameterName) |
Returns number of threads. More... | |
float | getThreadFloatParam (const int ThreadNr, const char *parameterName) |
Returns thread parameter number of name "parameterName" > 0 if parameter exists. More... | |
int | getThreadIntParam (const int ThreadNr, const char *parameterName) |
Returns thread parameter of float type. More... | |
bool | getThreadBooleanParam (const int ThreadNr, const char *parameterName) |
Returns thread parameter of int type. More... | |
std::string | getThreadStringParam (const int ThreadNr, const char *parameterName) |
Returns thread parameter of boolean type. More... | |
float | getThreadFloatVectorParam (const int component, const int ThreadNr, const char *parameterName) |
Returns thread parameter of string type. More... | |
int | getThreadIntVectorParam (const int component, const int ThreadNr, const char *parameterName) |
Returns thread parameter of vector component of float type. More... | |
std::string | getThreadStringVectorParam (const int component, const int ThreadNr, const char *parameterName) |
Returns thread parameter of vector component of int type. More... | |
int | getThreadDataVectorParamLength (const int ThreadNr, const int DataNr, const char *dataName, const char *parameterName) |
Returns thread parameter of string component of int type. More... | |
float | getThreadDataFloatVectorParam (const int component, const int ThreadNr, const int DataNr, const char *dataName, const char *parameterName) |
Returns thread data parameter length > 0 if parameter exists. More... | |
int | getThreadDataIntVectorParam (const int component, const int ThreadNr, const int DataNr, const char *dataName, const char *parameterName) |
Returns thread parameter of vector component of float type. More... | |
Static Public Member Functions | |
static std::shared_ptr< MF::Database::ConfigData > | New (const char *pPathToProgramConfigFile, const char *pPathToCaseFolder, const char *pScope, bool verbose) |
Data Fields | |
std::string | CaseFolder |
Path to case folder (relative to program folder). More... | |
std::string | ProgramConfigFile |
Full path to program config file (relative to program folder). More... | |
std::string | CaseFile |
Full path to case config file (relative to program folder). More... | |
std::string | ThreadFile |
Full path to thread file (relative to program folder). More... | |
std::string | GeometryFile |
Full path to geometry file (relative to program folder). More... | |
The ConfigData class provides accessors for text parser objects: case parameters, program parameters and thread parameters.
That are created during parsing of files: case_params.cfg, Microflow.cfg and thread_params.cfg.
Definition at line 23 of file ConfigData.h.
MF::Database::ConfigData::ConfigData | ( | const char * | pPathToProgramConfigFile, |
const char * | pPathToCaseFolder, | ||
const char * | pScope, | ||
bool | verbose | ||
) |
Definition at line 21 of file ConfigData.cpp.
References CaseFile, CaseFolder, GeometryFile, ProgramConfigFile, and ThreadFile.
MF::Database::ConfigData::~ConfigData | ( | ) |
Definition at line 12 of file ConfigData.cpp.
|
inline |
Returns case parameter of int type.
Definition at line 43 of file ConfigData.h.
|
inline |
Returns number of case parameter of name "parameterName" > 0 if parameter exists.
Definition at line 41 of file ConfigData.h.
|
inline |
Returns case parameter of string type.
Definition at line 46 of file ConfigData.h.
|
inline |
Returns case parameter of float type.
Definition at line 42 of file ConfigData.h.
|
inline |
Returns case parameter of vector component of float type.
Definition at line 48 of file ConfigData.h.
|
inline |
Returns pointer to program parameters parser object.
Definition at line 36 of file ConfigData.h.
|
inline |
Definition at line 40 of file ConfigData.h.
|
inline |
Returns case parameter of boolean type.
Definition at line 44 of file ConfigData.h.
|
inline |
Returns the way of GeometryDefinition of enum type: 0 - FromSTL.
Definition at line 52 of file ConfigData.h.
|
inline |
Returns case parameter of vector X component of int type.
Definition at line 51 of file ConfigData.h.
|
inline |
Returns the ModelType parameter of enum type: 0 - BGK, 1 - MRT, 2 - FBGK, 3- MRT2.
Definition at line 54 of file ConfigData.h.
|
inline |
Returns the FlowType parameter of enum type: 0 - quasi compressible, 1 - incompressible Zou et al. 1995.
Definition at line 53 of file ConfigData.h.
|
inline |
Returns program parameter of int type.
Definition at line 60 of file ConfigData.h.
|
inline |
Returns number of program parameter of name "parameterName" > 0 if parameter exists.
Definition at line 58 of file ConfigData.h.
|
inline |
Returns program parameter of string type.
Definition at line 63 of file ConfigData.h.
|
inline |
Returns program parameter of float type.
Definition at line 59 of file ConfigData.h.
|
inline |
Returns program parameter of vector component of float type.
Definition at line 65 of file ConfigData.h.
|
inline |
Returns pointer to text parser object.
Definition at line 35 of file ConfigData.h.
|
inline |
Returns the LatticeType parameter of enum type: 0 - D3Q19.
Definition at line 57 of file ConfigData.h.
|
inline |
Returns program parameter of boolean type.
Definition at line 61 of file ConfigData.h.
|
inline |
Definition at line 34 of file ConfigData.h.
|
inline |
Returns thread parameter of int type.
Definition at line 73 of file ConfigData.h.
References getThreadsNumber().
|
inline |
Returns thread data parameter length > 0 if parameter exists.
Definition at line 86 of file ConfigData.h.
References getThreadParamLength().
|
inline |
Returns thread parameter of vector component of float type.
Definition at line 88 of file ConfigData.h.
References getThreadParamLength().
|
inline |
Returns thread parameter of string component of int type.
Definition at line 84 of file ConfigData.h.
References getThreadParamLength().
|
inline |
Returns thread parameter number of name "parameterName" > 0 if parameter exists.
Definition at line 71 of file ConfigData.h.
References getThreadsNumber().
|
inline |
Returns thread parameter of string type.
Definition at line 77 of file ConfigData.h.
References getThreadsNumber().
|
inline |
Returns thread parameter of float type.
Definition at line 72 of file ConfigData.h.
References getThreadsNumber().
|
inline |
Returns thread parameter of vector component of float type.
Definition at line 79 of file ConfigData.h.
References getThreadsNumber().
|
inline |
Returns pointer to case parameters parser object.
Returns pointer to thread config file parser object.
Definition at line 37 of file ConfigData.h.
|
inline |
Returns number of threads.
Definition at line 69 of file ConfigData.h.
References getThreadsNumber().
Referenced by getThreadDataFloatVectorParam(), getThreadDataIntVectorParam(), and getThreadDataVectorParamLength().
|
inline |
Returns program parameter of vector component of int type.
Definition at line 68 of file ConfigData.h.
Referenced by getThreadBooleanParam(), getThreadFloatParam(), getThreadFloatVectorParam(), getThreadIntParam(), getThreadIntVectorParam(), getThreadParamLength(), getThreadStringParam(), and getThreadStringVectorParam().
|
inline |
Returns thread parameter of boolean type.
Definition at line 74 of file ConfigData.h.
References getThreadsNumber().
|
inline |
Returns thread parameter of vector component of int type.
Definition at line 81 of file ConfigData.h.
References getThreadsNumber().
|
inlinestatic |
Definition at line 28 of file ConfigData.h.
Referenced by main().
std::string MF::Database::ConfigData::CaseFile |
Full path to case config file (relative to program folder).
Definition at line 110 of file ConfigData.h.
Referenced by ConfigData().
std::string MF::Database::ConfigData::CaseFolder |
Path to case folder (relative to program folder).
Definition at line 108 of file ConfigData.h.
Referenced by ConfigData().
std::string MF::Database::ConfigData::GeometryFile |
Full path to geometry file (relative to program folder).
Definition at line 112 of file ConfigData.h.
Referenced by ConfigData().
std::string MF::Database::ConfigData::ProgramConfigFile |
Full path to program config file (relative to program folder).
Definition at line 109 of file ConfigData.h.
Referenced by ConfigData().
std::string MF::Database::ConfigData::ThreadFile |
Full path to thread file (relative to program folder).
Definition at line 111 of file ConfigData.h.
Referenced by ConfigData().