OGS
ProcessLib::RichardsComponentTransport Namespace Reference

Namespaces

namespace  anonymous_namespace{CreateRichardsComponentTransportProcess.cpp}

Classes

struct  IntegrationPointData
class  LocalAssemblerData
class  RichardsComponentTransportLocalAssemblerInterface
class  RichardsComponentTransportProcess
struct  RichardsComponentTransportProcessData

Functions

std::unique_ptr< ProcesscreateRichardsComponentTransportProcess (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 = 2

Function Documentation

◆ createRichardsComponentTransportProcess()

std::unique_ptr< Process > ProcessLib::RichardsComponentTransport::createRichardsComponentTransportProcess ( 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
Input File Parameter
prj__processes__process__RichardsComponentTransport__coupling_scheme

Process Variables

Input File Parameter
prj__processes__process__RichardsComponentTransport__process_variables

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

Input File Parameter
prj__processes__process__RichardsComponentTransport__process_variables__concentration
Input File Parameter
prj__processes__process__RichardsComponentTransport__process_variables__pressure

Process Parameters

Input File Parameter
prj__processes__process__RichardsComponentTransport__specific_body_force

Definition at line 72 of file CreateRichardsComponentTransportProcess.cpp.

81{
83 config.checkConfigParameter("type", "RichardsComponentTransport");
84
85 DBUG("Create RichardsComponentTransportProcess.");
86
87 auto const coupling_scheme =
89 config.getConfigParameterOptional<std::string>("coupling_scheme");
90 const bool use_monolithic_scheme =
91 !(coupling_scheme && (*coupling_scheme == "staggered"));
92
94
96 auto const pv_config = config.getConfigSubtree("process_variables");
97
98 std::vector<std::vector<std::reference_wrapper<ProcessVariable>>>
99 process_variables;
100 if (use_monolithic_scheme) // monolithic scheme.
101 {
104 auto per_process_variables = findProcessVariables(
105 variables, pv_config,
106 {
107 "concentration",
109 "pressure"});
110 if (per_process_variables.size() > 2)
111 {
112 OGS_FATAL(
113 "By now RichardsComponentTransport process only supports "
114 "single component transport simulation.");
115 }
116 process_variables.push_back(std::move(per_process_variables));
117 }
118 else // staggered scheme.
119 {
120 OGS_FATAL("The staggered coupling scheme is not implemented.");
121 }
122
124 // Specific body force parameter.
125 Eigen::VectorXd specific_body_force;
126 std::vector<double> const b =
128 config.getConfigParameter<std::vector<double>>("specific_body_force");
129 assert(!b.empty() && b.size() < 4);
130 if (b.size() < mesh.getDimension())
131 {
132 OGS_FATAL(
133 "specific body force (gravity vector) has {:d} components, mesh "
134 "dimension is {:d}",
135 b.size(), mesh.getDimension());
136 }
137 bool const has_gravity = MathLib::toVector(b).norm() > 0;
138 if (has_gravity)
139 {
140 specific_body_force.resize(b.size());
141 std::copy_n(b.data(), b.size(), specific_body_force.data());
142 }
143
144 auto media_map =
146
147 DBUG(
148 "Check the media properties of RichardsComponentTransport process ...");
149 checkMPLProperties(mesh, media_map);
150 DBUG("Media properties verified.");
151
153 std::move(media_map), specific_body_force, has_gravity};
154
155 SecondaryVariableCollection secondary_variables;
156
157 ProcessLib::createSecondaryVariables(config, secondary_variables);
158
159 return std::make_unique<RichardsComponentTransportProcess>(
160 std::move(name), mesh, std::move(jacobian_assembler), parameters,
161 integration_order, std::move(process_variables),
162 std::move(process_data), std::move(secondary_variables),
163 use_monolithic_scheme);
164}
#define OGS_FATAL(...)
Definition Error.h:19
void DBUG(fmt::format_string< Args... > fmt, Args &&... args)
Definition Logging.h:22
unsigned getDimension() const
Definition Mesh.h:80
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(), MaterialPropertyLib::createMaterialSpatialDistributionMap(), ProcessLib::createSecondaryVariables(), DBUG(), ProcessLib::findProcessVariables(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigParameterOptional(), BaseLib::ConfigTree::getConfigSubtree(), MeshLib::Mesh::getDimension(), OGS_FATAL, and MathLib::toVector().

Referenced by ProjectData::parseProcesses().

Variable Documentation

◆ NUM_NODAL_DOF