CaseParameters.h

Go to the documentation of this file.

// ==============================================================================================
// Microflow 3D, http://www.microflow.pwr.edu.pl/
// Created by Roman Szafran on 28.04.19.
// Copyright (c) 2019 Wroclaw University of Science and Technology.
// Distributed under the Apache License, Version 2.0. You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0 or see accompanying file license.txt.
// Redistributions of source code must retain the above copyright and license notice.
// ==============================================================================================

# pragma once

#include <string>
#include <vector>
#include "MFDatabase/ConfigData.h"
#include <memory>

namespace MF {
    namespace Solver_CPU {

//****************************************************************************************************************************
//CASE PARAMETERS
//****************************************************************************************************************************

            enum class FlowTypeClass {
                QuasiCompressible = 0, Incompressible = 1
            };

            enum class ModelTypeClass {
                BGK = 0, MRT = 1, FBGK = 2, MRT2 = 3
            };

            enum class LatticeTypeClass {
                D3Q19 = 0
            };

            enum class GeometryDefinitionClass {
                FromSTL = 0
            };

            class CaseParameters {
            public:
                explicit CaseParameters(const std::shared_ptr<MF::Database::ConfigData>& ConfigData_Ptr);

                ~CaseParameters() = default;

                static std::shared_ptr<MF::Solver_CPU::CaseParameters> New(std::shared_ptr<MF::Database::ConfigData> ConfigData_Ptr) {
                    auto CaseParameters_Ptr = std::make_shared<MF::Solver_CPU::CaseParameters>(ConfigData_Ptr);
                    return CaseParameters_Ptr;
                };

                //Geometry parameters
                std::string GeometryName; 
                double VoxelSize; 
                double PhysicalVoxelSize; 
                double AddInnerWall; 

                //Model parameters
                GeometryDefinitionClass GeometryDefinition;    
                FlowTypeClass FluidFlowModel_MT;            
                ModelTypeClass CollisionModel_KT;            
                LatticeTypeClass LatticeType_La;            

                //Physical parameters of simulation
                double FluidPhysicalViscosity_Nu_Phys;                
                double FluidPhysicalReferenceDensity_Rho0_Phys;        
                double Tau;                                            
                double ForceX_fiz;                                    
                double ForceY_fiz;                                    
                double ForceZ_fiz;                                    

                //Case characteristic parameters
                double CharactLengthPhysical_L_CH_Phys;            
                double CharactVelocityPhysical_U_CH_Phys;        

                // Termination conditions
                double Sc_VelocityResidueError_ErrV;         
                double MassFlowError_ErrM;                      

                // Initial and reference conditions
                double ReferenceDensityLB_Rho0_LB;                    
                double XInitialVelocityUx0_Phys;                  
                double YInitialVelocityUy0_Phys;                  
                double ZInitialVelocityUz0_Phys;                  

                // Parameters of automatic detection and addition of boundary nodes
                int DefaultWallNode_BN;                            
                int DefaultNode_NN;                                

                // Global parameters calculated during initialization
                unsigned int XNodesNumber_Nx1;                
                unsigned int YNodesNumber_Ny1;                
                unsigned int ZNodesNumber_Nz1;                
                double ReynoldsNumber_Re;                    
                double CharacteristicVelocityLBu_U_Ch_LB;    
                double CharacteristicLength_L_CH_LB;         
                double DTPhysical_Dt_Phys;                    
                double FluidLBuViscosity_Nu_LB;                
                double ForceX_LB;                            
                double ForceY_LB;                            
                double ForceZ_LB;                            
                double XInitialVelocityLBu_Ux0_LB;           
                double YInitialVelocityLBu_Uy0_LB;           
                double ZInitialVelocityLBu_Uz0_LB;           

                //MFThread parameters
                uint32_t ThreadMaxSize;

                // Calculation and display parameters
                unsigned int CheckPointNumberRead_CHP_R; 
                unsigned int VTKWriteStep_VTK_W;    
                unsigned int VTKFileMaxNumber_VTK_Max;
                unsigned int ConsoleWriteStep_K_W;            

                //Mass balance surface choice params
                bool AutomaticSurfaceChoice;

                // CPU parameters
                int CPU_ThreadsNr {0}; 
            };
    } /* namespace Solver_CPU */
} /* namespace MF */