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 71 of file CreateRichardsComponentTransportProcess.cpp.

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