The ProgramParameters class stores paths to program files and folders. More...

#include <ProgramParameters.h>

Collaboration diagram for MF::Solver_CPU::ProgramParameters:

Public Member Functions
	ProgramParameters (const std::shared_ptr< MF::Database::ConfigData > &ConfigData_Ptr)

	~ProgramParameters ()=default

Static Public Member Functions
static std::shared_ptr< MF::Solver_CPU::ProgramParameters >	New (const std::shared_ptr< MF::Database::ConfigData > &ConfigData_Ptr)

Data Fields
std::string	CaseFolder
	Path to case folder. More...

std::string	GeometryFolder
	Path to geometry folder. More...

std::string	GeometryFileName
	Geometry file name and path (relative to case folder). More...

std::string	CaseParametersFile
	Case parameters file name and path (relative to case folder). More...

std::string	ThreadParametersFile
	Thread parameters file name and path (relative to case folder). More...

std::string	ProgramParametersFile
	Program parameters file name and path (relative to case folder). More...

std::string	CheckPointFile
	Checkpoint file name and path (relative to case folder), without file extension. More...

std::string	OutputFile
	Results (output) file name and path (relative to case folder), without file extension. More...

Detailed Description

The ProgramParameters class stores paths to program files and folders.

Definition at line 21 of file ProgramParameters.h.

Constructor & Destructor Documentation

◆ ProgramParameters()

MF::Solver_CPU::ProgramParameters::ProgramParameters ( const std::shared_ptr< MF::Database::ConfigData > & ConfigData_Ptr )

explicit

Definition at line 12 of file ProgramParameters.cpp.

References CaseFolder, CaseParametersFile, CheckPointFile, GeometryFileName, GeometryFolder, OutputFile, ProgramParametersFile, and ThreadParametersFile.

                                                                                                           {
     try {
         CaseFolder = ConfigData_Ptr->CaseFolder;
         GeometryFolder = ConfigData_Ptr->getProgramStringParam("GeometryFolder");
         GeometryFileName = ConfigData_Ptr->getProgramStringParam("GeometryFileName");
         CaseParametersFile = ConfigData_Ptr->getProgramStringParam("CaseParametersFile");
         ThreadParametersFile = ConfigData_Ptr->getProgramStringParam("ThreadParametersFile");
         ProgramParametersFile = ConfigData_Ptr->ProgramConfigFile;
         CheckPointFile = ConfigData_Ptr->getProgramStringParam("CheckPointFile");
         OutputFile = ConfigData_Ptr->getProgramStringParam("OutputFile");
     }
     catch (const config4cpp::ConfigurationException &exception) {
         std::cout << "[ProgramParameters::Initialize] Error of initialization program parameters from a file: ";
         std::cout << exception.c_str() << std::endl;
         exit(EXIT_FAILURE);
     }
 }

◆ ~ProgramParameters()

MF::Solver_CPU::ProgramParameters::~ProgramParameters ( )

default

Member Function Documentation

◆ New()

static std::shared_ptr<MF::Solver_CPU::ProgramParameters> MF::Solver_CPU::ProgramParameters::New ( const std::shared_ptr< MF::Database::ConfigData > & ConfigData_Ptr )

inlinestatic

Definition at line 27 of file ProgramParameters.h.

Referenced by main().

                                                                                                                                {
                 auto ProgramParameters_Ptr = std::make_shared<MF::Solver_CPU::ProgramParameters>(ConfigData_Ptr);
                 return ProgramParameters_Ptr;
             };

Field Documentation

◆ CaseFolder

std::string MF::Solver_CPU::ProgramParameters::CaseFolder

Path to case folder.

Definition at line 30 of file ProgramParameters.h.

Referenced by ProgramParameters().

◆ CaseParametersFile

std::string MF::Solver_CPU::ProgramParameters::CaseParametersFile

Case parameters file name and path (relative to case folder).

Definition at line 39 of file ProgramParameters.h.

Referenced by ProgramParameters().

◆ CheckPointFile

std::string MF::Solver_CPU::ProgramParameters::CheckPointFile

Checkpoint file name and path (relative to case folder), without file extension.

Definition at line 42 of file ProgramParameters.h.

Referenced by ProgramParameters().

◆ GeometryFileName

std::string MF::Solver_CPU::ProgramParameters::GeometryFileName

Geometry file name and path (relative to case folder).

Definition at line 38 of file ProgramParameters.h.

Referenced by ProgramParameters().

◆ GeometryFolder

std::string MF::Solver_CPU::ProgramParameters::GeometryFolder

Path to geometry folder.

Definition at line 37 of file ProgramParameters.h.

Referenced by ProgramParameters().

◆ OutputFile

std::string MF::Solver_CPU::ProgramParameters::OutputFile

Results (output) file name and path (relative to case folder), without file extension.

Definition at line 43 of file ProgramParameters.h.

Referenced by ProgramParameters().

◆ ProgramParametersFile

std::string MF::Solver_CPU::ProgramParameters::ProgramParametersFile

Program parameters file name and path (relative to case folder).

Definition at line 41 of file ProgramParameters.h.

Referenced by ProgramParameters().

◆ ThreadParametersFile

std::string MF::Solver_CPU::ProgramParameters::ThreadParametersFile

Thread parameters file name and path (relative to case folder).

Definition at line 40 of file ProgramParameters.h.

Referenced by ProgramParameters().

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

/home/romek/CLionProjects/Microflow_3D_v1/source/MFSolver_CPU/ProgramParameters.h
/home/romek/CLionProjects/Microflow_3D_v1/source/MFSolver_CPU/ProgramParameters.cpp

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ ProgramParameters()

◆ ~ProgramParameters()

Member Function Documentation

◆ New()

Field Documentation

◆ CaseFolder

◆ CaseParametersFile

◆ CheckPointFile

◆ GeometryFileName

◆ GeometryFolder

◆ OutputFile

◆ ProgramParametersFile

◆ ThreadParametersFile