OGS
ProcessLib::RichardsFlow Namespace Reference

Classes

struct  IntegrationPointData
class  LocalAssemblerData
class  RichardsFlowLocalAssemblerInterface
class  RichardsFlowProcess
struct  RichardsFlowProcessData

Functions

void checkMPLProperties (MeshLib::Mesh const &mesh, MaterialPropertyLib::MaterialSpatialDistributionMap const &media_map)
std::unique_ptr< ProcesscreateRichardsFlowProcess (std::string const &name, MeshLib::Mesh &mesh, std::unique_ptr< ProcessLib::AbstractJacobianAssembler > &&jacobian_assembler, std::vector< ProcessVariable > const &variables, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, unsigned const integration_order, BaseLib::ConfigTree const &config, std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &media)

Variables

const unsigned NUM_NODAL_DOF = 1

Function Documentation

◆ checkMPLProperties()

void ProcessLib::RichardsFlow::checkMPLProperties ( MeshLib::Mesh const & mesh,
MaterialPropertyLib::MaterialSpatialDistributionMap const & media_map )

Definition at line 19 of file CreateRichardsFlowProcess.cpp.

22{
23 std::array const required_medium_properties = {
30
31 std::array const required_liquid_properties = {
34
35 std::array<MaterialPropertyLib::PropertyType, 0> const
36 required_solid_properties{};
37
38 std::array<MaterialPropertyLib::PropertyType, 0> const empty{};
39
41 mesh, media_map, required_medium_properties, required_solid_properties,
42 required_liquid_properties, empty);
43}
void checkMaterialSpatialDistributionMap(MeshLib::Mesh const &mesh, MaterialPropertyLib::MaterialSpatialDistributionMap const &media_map, ContainerMedium const &required_properties_medium, ContainerSolid const &required_properties_solid_phase, ContainerLiquid const &required_properties_liquid_phase, ContainerGas const &required_properties_gas_phase)

References MaterialPropertyLib::checkMaterialSpatialDistributionMap(), MaterialPropertyLib::density, MaterialPropertyLib::permeability, MaterialPropertyLib::porosity, MaterialPropertyLib::reference_temperature, MaterialPropertyLib::relative_permeability, MaterialPropertyLib::saturation, MaterialPropertyLib::storage, and MaterialPropertyLib::viscosity.

Referenced by createRichardsFlowProcess().

◆ createRichardsFlowProcess()

std::unique_ptr< Process > ProcessLib::RichardsFlow::createRichardsFlowProcess ( std::string const & name,
MeshLib::Mesh & mesh,
std::unique_ptr< ProcessLib::AbstractJacobianAssembler > && jacobian_assembler,
std::vector< ProcessVariable > const & variables,
std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const & parameters,
unsigned const integration_order,
BaseLib::ConfigTree const & config,
std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const & media )
Input File Parameter
prj__processes__process__type

Process Variables

Input File Parameter
prj__processes__process__RICHARDS_FLOW__process_variables

Primary process variables as they appear in the global component vector:

Input File Parameter
prj__processes__process__RICHARDS_FLOW__process_variables__process_variable

Process Parameters

Input File Parameter
prj__processes__process__RICHARDS_FLOW__specific_body_force
Input File Parameter
prj__processes__process__RICHARDS_FLOW__mass_lumping

Definition at line 45 of file CreateRichardsFlowProcess.cpp.

54{
56 config.checkConfigParameter("type", "RICHARDS_FLOW");
57
58 DBUG("Create RichardsFlowProcess.");
59
61
63 auto const pv_config = config.getConfigSubtree("process_variables");
64
66 auto per_process_variables = findProcessVariables(
67 variables, pv_config,
68 {
69 "process_variable"});
70 std::vector<std::vector<std::reference_wrapper<ProcessVariable>>>
71 process_variables;
72 process_variables.push_back(std::move(per_process_variables));
73
74 SecondaryVariableCollection secondary_variables;
75
76 ProcessLib::createSecondaryVariables(config, secondary_variables);
77
79 // Specific body force
80 std::vector<double> const b =
82 config.getConfigParameter<std::vector<double>>("specific_body_force");
83 assert(!b.empty() && b.size() < 4);
84 Eigen::VectorXd specific_body_force(b.size());
85 bool const has_gravity = MathLib::toVector(b).norm() > 0;
86 if (has_gravity)
87 {
88 std::copy_n(b.data(), b.size(), specific_body_force.data());
89 }
90
91 // has mass lumping
93 auto mass_lumping = config.getConfigParameter<bool>("mass_lumping");
94
95 auto media_map =
97
98 DBUG("Check the media properties of RichardsFlow process ...");
99 checkMPLProperties(mesh, media_map);
100 DBUG("Media properties verified.");
101
102 RichardsFlowProcessData process_data{
103 std::move(media_map), specific_body_force, has_gravity, mass_lumping};
104
105 return std::make_unique<RichardsFlowProcess>(
106 std::move(name), mesh, std::move(jacobian_assembler), parameters,
107 integration_order, std::move(process_variables),
108 std::move(process_data), std::move(secondary_variables));
109}
void DBUG(fmt::format_string< Args... > fmt, Args &&... args)
Definition Logging.h:22
Handles configuration of several secondary variables from the project file.
MaterialSpatialDistributionMap createMaterialSpatialDistributionMap(std::map< int, std::shared_ptr< Medium > > const &media, MeshLib::Mesh const &mesh)
Eigen::Map< const Vector > toVector(std::vector< double > const &data, Eigen::VectorXd::Index size)
Creates an Eigen mapped vector from the given data vector.
void checkMPLProperties(MeshLib::Mesh const &mesh, MaterialPropertyLib::MaterialSpatialDistributionMap const &media_map)
std::vector< std::reference_wrapper< ProcessVariable > > findProcessVariables(std::vector< ProcessVariable > const &variables, BaseLib::ConfigTree const &pv_config, std::initializer_list< std::string > tags)
void createSecondaryVariables(BaseLib::ConfigTree const &config, SecondaryVariableCollection &secondary_variables)

References BaseLib::ConfigTree::checkConfigParameter(), checkMPLProperties(), MaterialPropertyLib::createMaterialSpatialDistributionMap(), ProcessLib::createSecondaryVariables(), DBUG(), ProcessLib::findProcessVariables(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigSubtree(), and MathLib::toVector().

Referenced by ProjectData::parseProcesses().

Variable Documentation

◆ NUM_NODAL_DOF