A class whose object is responsible for storing all case parameters. More...

#include <CaseParameters.h>

Collaboration diagram for MF::Solver_CPU::CaseParameters:

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

	~CaseParameters ()=default

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

Data Fields
std::string	GeometryName
	Name of the geometry. More...

double	VoxelSize
	Length of edge of square voxel (unite volume). E.g if the length of geometry edge equals 10 units and we want to have 11 nodes on the edge, the voxel size is 1. More...

double	PhysicalVoxelSize
	Length in [m] that corresponds to 1 Lu (lattice unit length) or one voxel edge length. Physical length [m] corresponding to one unit length in LB (distance between two nodes). More...

double	AddInnerWall
	Adds additional layer of points on inner wals when substracting small closed surfaces from the grid. The value should be < VoxelSize to add one voxel of luid. (0 = no addition). More...

GeometryDefinitionClass	GeometryDefinition
	Geometry definition method: 0 - FromSTL. More...

FlowTypeClass	FluidFlowModel_MT
	Flow models: 0 - quasi compressible (e.g air), 1 - incompressible (e.g water) - Zou et al. 1995. More...

ModelTypeClass	CollisionModel_KT
	Collision models: 0 – BGK, 1 - MRT, 2 - FBGK (BGK with force), MRT2 - with optimized relaxation time parameters. More...

LatticeTypeClass	LatticeType_La
	(D3Q19) Lattice type: 0 - D3Q19 More...

double	FluidPhysicalViscosity_Nu_Phys
	The physical kinematic viscosity of the fluid [m^2/s]. More...

double	FluidPhysicalReferenceDensity_Rho0_Phys
	The physical density of fluid [kg/m3]. More...

double	Tau
	Tau > 0.5, minimal values (0.525 MRT, 0.58 BGK). More...

double	ForceX_fiz
	The X component of the volumetric force, e.g. the force of gravity [N/m3]. More...

double	ForceY_fiz
	The Y component of the volumetric force, e.g. the force of gravity [N/m3]. More...

double	ForceZ_fiz
	The Z component of the volumetric force, e.g. the force of gravity [N/m3]. More...

double	CharactLengthPhysical_L_CH_Phys
	Physical length [m] of characteristic dimension. More...

double	CharactVelocityPhysical_U_CH_Phys
	Physical characteristic mean velocity for characteristic dimension [m/s]. More...

double	Sc_VelocityResidueError_ErrV
	Velocity termination condition - the mean scaled residue of average velocity for subsequent steps. More...

double	MassFlowError_ErrM
	Mass flow termination condition - the mass flow error for subsequent steps calculated for balance surfaces [%]. More...

double	ReferenceDensityLB_Rho0_LB
	Density LB at the reference point, ususally at the outflow. More...

double	XInitialVelocityUx0_Phys
	Initial value of velocity [m/s] in the X direction. More...

double	YInitialVelocityUy0_Phys
	Initial value of velocity [m/s] in the Y direction. More...

double	ZInitialVelocityUz0_Phys
	Initial value of velocity [m/s] in the Z direction. More...

int	DefaultWallNode_BN
	The default type of node on the wall (40). More...

int	DefaultNode_NN
	The default type of node unrecognized (61). More...

unsigned int	XNodesNumber_Nx1
	Total number of nodes in X direction (geometry extent). More...

unsigned int	YNodesNumber_Ny1
	Total number of nodes in Y direction (geometry extent). More...

unsigned int	ZNodesNumber_Nz1
	Total number of nodes in Z direction (geometry extent). More...

double	ReynoldsNumber_Re
	Reynolds number. More...

double	CharacteristicVelocityLBu_U_Ch_LB
	Characteristic velocity LB. More...

double	CharacteristicLength_L_CH_LB
	Characteristic length [Lu]. More...

double	DTPhysical_Dt_Phys
	Physical time dt [s] corresponding to one time step LB. More...

double	FluidLBuViscosity_Nu_LB
	Kinematic viscosity LB. More...

double	ForceX_LB
	The X component of the volumetric force, e.g. the force of gravity. More...

double	ForceY_LB
	The Y component of the volumetric force, e.g. the force of gravity. More...

double	ForceZ_LB
	The Z component of the volumetric force, e.g. the force of gravity. More...

double	XInitialVelocityLBu_Ux0_LB
	Initial value of LB velocity in the X direction. More...

double	YInitialVelocityLBu_Uy0_LB
	Initial value of LB velocity in the Y direction. More...

double	ZInitialVelocityLBu_Uz0_LB
	Initial value of LB velocity in the Z direction. More...

uint32_t	ThreadMaxSize

unsigned int	CheckPointNumberRead_CHP_R
	Check point number for resuming calculations, 0 - no check point resuming. More...

unsigned int	VTKWriteStep_VTK_W
	Step for save check points and VTK/VTI data files, 0 - write data only at the begining and at the end of calculations. More...

unsigned int	VTKFileMaxNumber_VTK_Max
	The maximum number of VTK/VTI files stored on the disk, in addition to initial and final files. More...

unsigned int	ConsoleWriteStep_K_W
	The step for displaying information on the console. More...

bool	AutomaticSurfaceChoice

int	CPU_ThreadsNr {0}
	Number of CPU threads to allocate. More...

Detailed Description

A class whose object is responsible for storing all case parameters.

Definition at line 45 of file CaseParameters.h.

Constructor & Destructor Documentation

◆ CaseParameters()

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

explicit

Definition at line 12 of file CaseParameters.cpp.

References AddInnerWall, AutomaticSurfaceChoice, CharacteristicLength_L_CH_LB, CharacteristicVelocityLBu_U_Ch_LB, CharactLengthPhysical_L_CH_Phys, CharactVelocityPhysical_U_CH_Phys, CheckPointNumberRead_CHP_R, CollisionModel_KT, ConsoleWriteStep_K_W, CPU_ThreadsNr, DefaultNode_NN, DefaultWallNode_BN, DTPhysical_Dt_Phys, FluidFlowModel_MT, FluidLBuViscosity_Nu_LB, FluidPhysicalReferenceDensity_Rho0_Phys, FluidPhysicalViscosity_Nu_Phys, ForceX_fiz, ForceX_LB, ForceY_fiz, ForceY_LB, ForceZ_fiz, ForceZ_LB, GeometryDefinition, GeometryName, LatticeType_La, MassFlowError_ErrM, PhysicalVoxelSize, ReferenceDensityLB_Rho0_LB, ReynoldsNumber_Re, Sc_VelocityResidueError_ErrV, Tau, ThreadMaxSize, VoxelSize, VTKFileMaxNumber_VTK_Max, VTKWriteStep_VTK_W, XInitialVelocityLBu_Ux0_LB, XInitialVelocityUx0_Phys, XNodesNumber_Nx1, YInitialVelocityLBu_Uy0_LB, YInitialVelocityUy0_Phys, YNodesNumber_Ny1, ZInitialVelocityLBu_Uz0_LB, ZInitialVelocityUz0_Phys, and ZNodesNumber_Nz1.

                                                                                                     {
     try {
         //Geometry parameters
         GeometryName = ConfigData_Ptr->getCaseStringParam("GeometryParams.GeometryName");
         VoxelSize = ConfigData_Ptr->getCaseFloatParam("GeometryParams.VoxelSize");
         PhysicalVoxelSize = ConfigData_Ptr->getCaseFloatParam("GeometryParams.PhysicalVoxelSize");
         AddInnerWall = ConfigData_Ptr->getCaseFloatParam("GeometryParams.AddInnerWall");
 
         //Parameters of model
         GeometryDefinition = (GeometryDefinitionClass) ConfigData_Ptr->getGeometryDefinition();
         FluidFlowModel_MT = (FlowTypeClass) ConfigData_Ptr->getFlowType();
         CollisionModel_KT = (ModelTypeClass) ConfigData_Ptr->getModelType();
         LatticeType_La = (LatticeTypeClass) ConfigData_Ptr->getLatticeType();
 
         //Physical parameters of simulation
         FluidPhysicalViscosity_Nu_Phys = ConfigData_Ptr->getCaseFloatParam("PhysicalParams.FluidPhysicalViscosity_Nu_Phys");
         FluidPhysicalReferenceDensity_Rho0_Phys = ConfigData_Ptr->getCaseFloatParam("PhysicalParams.FluidPhysicalReferenceDensity_Rho0_Phys");
         Tau = ConfigData_Ptr->getCaseFloatParam("PhysicalParams.Tau");
         ForceX_fiz = ConfigData_Ptr->getCaseFloatVectorParam(0, "PhysicalParams.XYZForce_fiz");
         ForceY_fiz = ConfigData_Ptr->getCaseFloatVectorParam(1, "PhysicalParams.XYZForce_fiz");
         ForceZ_fiz = ConfigData_Ptr->getCaseFloatVectorParam(2, "PhysicalParams.XYZForce_fiz");
 
         //Case characteristic parameters
         CharactLengthPhysical_L_CH_Phys = ConfigData_Ptr->getCaseFloatParam("CharactersticParams.CharactLengthPhysical_L_CH_Phys");
         CharactVelocityPhysical_U_CH_Phys = ConfigData_Ptr->getCaseFloatParam("CharactersticParams.CharactVelocityPhysical_U_CH_Phys");
 
         //Termination conditions
         Sc_VelocityResidueError_ErrV = ConfigData_Ptr->getCaseFloatParam("TerminationCondition.Sc_VelocityResidueError_ErrV");
         MassFlowError_ErrM = ConfigData_Ptr->getCaseFloatParam("TerminationCondition.MassFlowError_ErrM");
 
         //Initial and reference conditions
         ReferenceDensityLB_Rho0_LB = ConfigData_Ptr->getCaseFloatParam("InitialCondition.ReferenceDensityLB_Rho0_LB");
 
         XInitialVelocityUx0_Phys = ConfigData_Ptr->getCaseFloatVectorParam(0, "InitialCondition.XYZInitialVelocityPhysical_U0");
         YInitialVelocityUy0_Phys = ConfigData_Ptr->getCaseFloatVectorParam(1, "InitialCondition.XYZInitialVelocityPhysical_U0");
         ZInitialVelocityUz0_Phys = ConfigData_Ptr->getCaseFloatVectorParam(2, "InitialCondition.XYZInitialVelocityPhysical_U0");
 
         //Parameters of automatic detection and addition of boundary nodes
         DefaultWallNode_BN = ConfigData_Ptr->getCaseIntParam("DefaultBoundaryCondition.DefaultWallNode_BN");
         DefaultNode_NN = ConfigData_Ptr->getCaseIntParam("DefaultBoundaryCondition.DefaultNode_NN");
 
         // Global parameters calculated during initialization
         XNodesNumber_Nx1 = (0);
         YNodesNumber_Ny1 = (0);
         ZNodesNumber_Nz1 = (0);
         ReynoldsNumber_Re = (0.0);
         CharacteristicVelocityLBu_U_Ch_LB = (0.0);
         DTPhysical_Dt_Phys = (0.0);
         CharacteristicLength_L_CH_LB = (0.0);
         FluidLBuViscosity_Nu_LB = (0.0);
         ForceX_LB = (0.0);
         ForceY_LB = (0.0);
         ForceZ_LB = (0.0);
         XInitialVelocityLBu_Ux0_LB = (0.0);
         YInitialVelocityLBu_Uy0_LB = (0.0);
         ZInitialVelocityLBu_Uz0_LB = (0.0);
 
         //MFThread parameters
         ThreadMaxSize = ConfigData_Ptr->getCaseIntParam("ThreadParams.MFThreadMaxSize");
 
         //Calculation and display parameters
         CheckPointNumberRead_CHP_R = ConfigData_Ptr->getCaseIntParam("RWParams.CheckPointNumberRead_CHP_R");
         VTKWriteStep_VTK_W = ConfigData_Ptr->getCaseIntParam("RWParams.VTKWriteStep_VTK_W");
         VTKFileMaxNumber_VTK_Max = ConfigData_Ptr->getCaseIntParam("RWParams.VTKFileMaxNumber_VTK_Max");
         ConsoleWriteStep_K_W = ConfigData_Ptr->getCaseIntParam("RWParams.ConsoleWriteStep_K_W");
 
         //Mass balance surface choice params
         AutomaticSurfaceChoice = ConfigData_Ptr->getCaseBooleanParam("BalanceParams.AutomaticSurfaceChoice");
 
         // CPU parameters
         CPU_ThreadsNr = ConfigData_Ptr->getCaseIntParam("CPUParams.CPU_ThreadsNr");
 
     }
     catch (const config4cpp::ConfigurationException &exception) {
         std::cout << "[CaseParameters::Initialize] Error during initialization of case parameter from a file: ";
         std::cout << exception.c_str() << std::endl;
         exit(EXIT_FAILURE);
     }
 }

◆ ~CaseParameters()

MF::Solver_CPU::CaseParameters::~CaseParameters ( )

default

Member Function Documentation

◆ New()

static std::shared_ptr<MF::Solver_CPU::CaseParameters> MF::Solver_CPU::CaseParameters::New ( std::shared_ptr< MF::Database::ConfigData > ConfigData_Ptr )

inlinestatic

Definition at line 51 of file CaseParameters.h.

Referenced by main().

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

Field Documentation

◆ AddInnerWall

double MF::Solver_CPU::CaseParameters::AddInnerWall

Adds additional layer of points on inner wals when substracting small closed surfaces from the grid. The value should be < VoxelSize to add one voxel of luid. (0 = no addition).

Definition at line 60 of file CaseParameters.h.

Public Member Functions

Static Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

◆ CaseParameters()

◆ ~CaseParameters()

Member Function Documentation

◆ New()

Field Documentation

◆ AddInnerWall

◆ AutomaticSurfaceChoice

◆ CharacteristicLength_L_CH_LB

◆ CharacteristicVelocityLBu_U_Ch_LB

◆ CharactLengthPhysical_L_CH_Phys

◆ CharactVelocityPhysical_U_CH_Phys

◆ CheckPointNumberRead_CHP_R

◆ CollisionModel_KT

◆ ConsoleWriteStep_K_W

◆ CPU_ThreadsNr

◆ DefaultNode_NN

◆ DefaultWallNode_BN

◆ DTPhysical_Dt_Phys

◆ FluidFlowModel_MT

◆ FluidLBuViscosity_Nu_LB

◆ FluidPhysicalReferenceDensity_Rho0_Phys

◆ FluidPhysicalViscosity_Nu_Phys

◆ ForceX_fiz

◆ ForceX_LB

◆ ForceY_fiz

◆ ForceY_LB

◆ ForceZ_fiz

◆ ForceZ_LB

◆ GeometryDefinition

◆ GeometryName

◆ LatticeType_La

◆ MassFlowError_ErrM

◆ PhysicalVoxelSize

◆ ReferenceDensityLB_Rho0_LB

◆ ReynoldsNumber_Re

◆ Sc_VelocityResidueError_ErrV

◆ Tau

◆ ThreadMaxSize

◆ VoxelSize

◆ VTKFileMaxNumber_VTK_Max

◆ VTKWriteStep_VTK_W

◆ XInitialVelocityLBu_Ux0_LB

◆ XInitialVelocityUx0_Phys

◆ XNodesNumber_Nx1

◆ YInitialVelocityLBu_Uy0_LB

◆ YInitialVelocityUy0_Phys

◆ YNodesNumber_Ny1

◆ ZInitialVelocityLBu_Uz0_LB

◆ ZInitialVelocityUz0_Phys

◆ ZNodesNumber_Nz1