ProcessLib Namespace Reference

Detailed Description

common nomenclature -----------—primary variable-------------------— pn_int_pt pressure for nonwetting phase at each integration point pc_int_pt capillary pressure at each integration point -----------—secondary variable-----------------— Sw wetting phase saturation dSw_dpc derivative of wetting phase saturation with respect to capillary pressure rho_nonwet density of nonwetting phase drhononwet_dpn derivative of nonwetting phase density with respect to nonwetting phase pressure rho_wet density of wetting phase k_rel_nonwet relative permeability of nonwetting phase mu_nonwet viscosity of nonwetting phase lambda_nonwet mobility of nonwetting phase k_rel_wet relative permeability of wetting phase mu_wet viscosity of wetting phase lambda_wet mobility of wetting phase

Namespaces
namespace	Assembly
namespace	BoundaryConditionAndSourceTerm
namespace	ComponentTransport
namespace	ConstitutiveRelations
namespace	Deformation
namespace	detail
namespace	Graph
namespace	HeatConduction
namespace	HeatTransportBHE
namespace	HMPhaseField
namespace	HT
namespace	HydroMechanics
namespace	LargeDeformation
namespace	LIE
namespace	LinearBMatrix
namespace	LiquidFlow
namespace	NonLinearBMatrix
namespace	NonLinearFbar
namespace	NormalTractionBoundaryCondition
namespace	PhaseField
namespace	Reflection
namespace	RichardsComponentTransport
namespace	RichardsFlow
namespace	RichardsMechanics
namespace	SmallDeformation
namespace	SourceTerms
namespace	SteadyStateDiffusion
namespace	TH2M
namespace	ThermalTwoPhaseFlowWithPP
namespace	ThermoHydroMechanics
namespace	ThermoMechanics
namespace	ThermoRichardsFlow
namespace	ThermoRichardsMechanics
namespace	TwoPhaseFlowWithPP
namespace	WellboreSimulator

Classes
class	AbstractJacobianAssembler
	Base class for Jacobian assemblers. More...
class	AnalyticalJacobianAssembler
class	AnchorTerm
struct	AssembledMatrixCache
	Stores assembled global M, K, b matrices/vectors for later reuse. More...
class	AssemblyMixin
class	AssemblyMixinBase
class	BHEInflowPythonBoundaryCondition
	A boundary condition whose values are computed by a Python script. More...
class	BHEInflowPythonBoundaryConditionPythonSideInterface
class	BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline
class	BMatrixPolicyType
class	BoundaryCondition
class	BoundaryConditionCollection
struct	BoundaryConditionConfig
struct	CellAverageData
class	CentralDifferencesJacobianAssembler
	Assembles the Jacobian matrix using central differences. More...
class	CompareJacobiansJacobianAssembler
class	ConstraintDirichletBoundaryCondition
struct	ConstraintDirichletBoundaryConditionConfig
class	ConstraintDirichletBoundaryConditionLocalAssembler
class	ConstraintDirichletBoundaryConditionLocalAssemblerInterface
struct	DeactivatedSubdomain
class	DeactivatedSubdomainDirichlet
struct	DeactivatedSubdomainMesh
class	DirichletBoundaryCondition
struct	DirichletBoundaryConditionConfig
class	DirichletBoundaryConditionWithinTimeInterval
class	EmbeddedAnchor
class	ExtrapolatorData
class	ForwardDifferencesJacobianAssembler
	Assembles the Jacobian matrix using forward differences. More...
struct	GenericLocalAssemblerFactory
class	GenericNaturalBoundaryCondition
class	GenericNaturalBoundaryConditionLocalAssembler
class	GenericNaturalBoundaryConditionLocalAssemblerInterface
class	GMatrixPolicyType
struct	HCNonAdvectiveFreeComponentFlowBoundaryConditionData
class	HCNonAdvectiveFreeComponentFlowBoundaryConditionLocalAssembler
class	HMatrixPolicyType
struct	InitialStress
struct	IntegrationPointData
class	LocalAssemblerBuilderFactory
class	LocalAssemblerBuilderFactoryTaylorHood
class	LocalAssemblerFactoryForDimGreaterEqualN
class	LocalAssemblerFactoryTaylorHood
class	LocalAssemblerInterface
struct	MethodNotOverriddenInDerivedClassException
struct	NeumannBoundaryConditionConfig
struct	NeumannBoundaryConditionData
class	NeumannBoundaryConditionLocalAssembler
class	NodalSourceTerm
class	Output
struct	OutputConfig
struct	OutputDataSpecification
	Holds information about which variables to write to output files. More...
struct	OutputFormat
struct	OutputVTKFormat
struct	OutputXDMFHDF5Format
struct	PairRepeatEachSteps
struct	Parameter
class	PhaseFieldIrreversibleDamageOracleBoundaryCondition
class	PrimaryVariableConstraintDirichletBoundaryCondition
struct	PrimaryVariableConstraintDirichletBoundaryConditionConfig
class	Process
struct	ProcessData
class	ProcessOutputData
	Holds all data of a process that are needed for output. More...
class	ProcessVariable
struct	PythonBcData
class	PythonBoundaryCondition
	A boundary condition whose values are computed by a Python script. More...
struct	PythonBoundaryConditionConfig
class	PythonBoundaryConditionLocalAssembler
class	PythonBoundaryConditionLocalAssemblerInterface
class	PythonBoundaryConditionPythonSideInterface
class	PythonBoundaryConditionPythonSideInterfaceTrampoline
class	ReleaseNodalForce
	Boundary condition for simulating excavation using the release nodal force approach. More...
struct	RobinBoundaryConditionConfig
struct	RobinBoundaryConditionData
class	RobinBoundaryConditionLocalAssembler
struct	SecondaryVariable
	Stores information about a specific secondary variable. More...
class	SecondaryVariableCollection
	Handles configuration of several secondary variables from the project file. More...
struct	SecondaryVariableFunctions
class	SolutionDependentDirichletBoundaryCondition
struct	SolutionDependentDirichletBoundaryConditionConfig
class	SourceTerm
class	SourceTermBase
class	SourceTermCollection
struct	SourceTermConfig
struct	SourceTermIntegrationPointData
class	SubmeshAssemblySupport
struct	SubmeshResiduumOutputConfig
class	SurfaceFlux
struct	SurfaceFluxData
class	SurfaceFluxLocalAssembler
class	SurfaceFluxLocalAssemblerInterface
class	TimeDecayDirichletBoundaryCondition
	Dirichlet boundary condition with time-dependent decay. More...
struct	TimeDecayDirichletBoundaryConditionConfig
class	TimeLoop
	Time loop capable of time-integrating several processes at once. More...
struct	TrafoIdentity
struct	TrafoLog
struct	TrafoScale
struct	TrafoTanh
struct	VariableDependentNeumannBoundaryConditionData
class	VariableDependentNeumannBoundaryConditionLocalAssembler
struct	VariableDependentNeumannConfig
class	VectorMatrixAssembler
class	VolumetricSourceTerm
class	VolumetricSourceTermLocalAssembler
class	VolumetricSourceTermLocalAssemblerInterface
struct	WellboreCompensateCoefficients
struct	WellboreCompensateNeumannBoundaryConditionData
class	WellboreCompensateNeumannBoundaryConditionLocalAssembler

Typedefs
using	HCNonAdvectiveFreeComponentFlowBoundaryCondition
using	NeumannBoundaryCondition
using	RobinBoundaryCondition
using	VariableDependentNeumannBoundaryCondition
using	WellboreCompensateNeumannBoundaryCondition
template<typename ShpPol, unsigned NNodes, unsigned NodalDOF, int Dim>
using	LocalAssemblerTraits
using	EnabledElementTraitsLagrange
template<typename LocalAssemblerInterface, template< typename, int > class LocalAssemblerImplementation, NumLib::IntegrationMethodProvider IntegrationMethodProvider, int GlobalDim, typename... ConstructorArgs>
using	LocalAssemblerFactory
	By default processes in OGS are defined in 1D, 2D and 3D.
template<typename LocalAssemblerInterface, template< typename, int > class LocalAssemblerImplementation, NumLib::IntegrationMethodProvider IntegrationMethodProvider, int GlobalDim, typename... ConstructorArgs>
using	LocalAssemblerFactorySD
	Mechanics processes in OGS are defined in 2D and 3D only.
template<typename LocalAssemblerInterface, template< typename, typename, int > class LocalAssemblerImplementation, NumLib::IntegrationMethodProvider IntegrationMethodProvider, int GlobalDim, typename... ConstructorArgs>
using	LocalAssemblerFactoryHM
	HM processes in OGS are defined for linear and higher order elements.
template<typename LocalAssemblerInterface, template< typename, typename, int > class LocalAssemblerImplementation, NumLib::IntegrationMethodProvider IntegrationMethodProvider, int GlobalDim, typename... ConstructorArgs>
using	LocalAssemblerFactoryStokes
	Stokes flow in OGS is defined for higher order elements only.
using	Trafo = ProcessLib::TrafoScale

Enumerations
enum class	OutputType : uint8_t { vtk , xdmf }

Functions
ConstraintDirichletBoundaryConditionConfig	parseConstraintDirichletBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< ConstraintDirichletBoundaryCondition >	createConstraintDirichletBoundaryCondition (ConstraintDirichletBoundaryConditionConfig const &config, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, int const variable_id, unsigned const integration_order, int const component_id, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, Process const &constraining_process)
template<int GlobalDim>
std::unique_ptr< SourceTerm >	createAnchorTerm (BaseLib::ConfigTree const &config, MeshLib::Mesh const &st_mesh, std::unique_ptr< NumLib::LocalToGlobalIndexMap > dof_table, std::size_t const source_term_mesh_id, const int variable_id, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
template std::unique_ptr< SourceTerm >	createAnchorTerm< 2 > (BaseLib::ConfigTree const &config, MeshLib::Mesh const &st_mesh, std::unique_ptr< NumLib::LocalToGlobalIndexMap > dof_table, std::size_t const source_term_mesh_id, const int variable_id, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
template std::unique_ptr< SourceTerm >	createAnchorTerm< 3 > (BaseLib::ConfigTree const &config, MeshLib::Mesh const &st_mesh, std::unique_ptr< NumLib::LocalToGlobalIndexMap > dof_table, std::size_t const source_term_mesh_id, const int variable_id, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::vector< std::unique_ptr< BoundaryCondition > >	createBoundaryCondition (const BoundaryConditionConfig &config, const NumLib::LocalToGlobalIndexMap &dof_table, const MeshLib::Mesh &bulk_mesh, const int variable_id, const unsigned integration_order, const unsigned shapefunction_order, const std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &parameters, const Process &process, std::vector< std::reference_wrapper< ProcessVariable > > const &all_process_variables_for_this_process, std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &media)
DirichletBoundaryConditionConfig	parseDirichletBoundaryConditionWithinTimeIntervalConfig (BaseLib::ConfigTree const &config)
std::unique_ptr< BoundaryCondition >	createDirichletBoundaryConditionWithinTimeInterval (DirichletBoundaryConditionConfig const &config_args, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, int const variable_id, int const component_id, const std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &parameters)
template<int GlobalDim>
std::unique_ptr< SourceTermBase >	createEmbeddedAnchor (BaseLib::ConfigTree const &config, MeshLib::Mesh const &st_mesh, MeshLib::Mesh const &bulk_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, std::size_t const source_term_mesh_id, const int variable_id)
template std::unique_ptr< SourceTermBase >	createEmbeddedAnchor< 2 > (BaseLib::ConfigTree const &config, MeshLib::Mesh const &st_mesh, MeshLib::Mesh const &bulk_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, std::size_t const source_term_mesh_id, const int variable_id)
template std::unique_ptr< SourceTermBase >	createEmbeddedAnchor< 3 > (BaseLib::ConfigTree const &config, MeshLib::Mesh const &st_mesh, MeshLib::Mesh const &bulk_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, std::size_t const source_term_mesh_id, const int variable_id)
std::unique_ptr< SourceTerm >	createNodalSourceTerm (BaseLib::ConfigTree const &config, MeshLib::Mesh const &st_mesh, std::unique_ptr< NumLib::LocalToGlobalIndexMap > dof_table, std::size_t const source_term_mesh_id, const int variable_id, const int component_id, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::string	parseReleaseNodalForce (BoundaryConditionConfig const &bc_config)
std::unique_ptr< BoundaryCondition >	createReleaseNodalForce (unsigned const global_dim, int const variable_id, std::string const &decay_parameter_name, BoundaryConditionConfig const &bc_config, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< SourceTermBase >	createSourceTerm (const SourceTermConfig &config, const NumLib::LocalToGlobalIndexMap &dof_table_bulk, const MeshLib::Mesh &source_term_mesh, const int variable_id, const unsigned integration_order, const unsigned shapefunction_order, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, std::vector< std::reference_wrapper< ProcessVariable > > const &all_process_variables_for_this_process, const MeshLib::Mesh &bulk_mesh)
TimeDecayDirichletBoundaryConditionConfig	parseTimeDecayDirichletBoundaryConditionConfig (BaseLib::ConfigTree const &config)
std::unique_ptr< BoundaryCondition >	createTimeDecayDirichletBoundaryCondition (TimeDecayDirichletBoundaryConditionConfig const &config, int const variable_id, int const component_id, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< SourceTerm >	createVolumetricSourceTerm (BaseLib::ConfigTree const &config, unsigned const bulk_mesh_dimension, MeshLib::Mesh const &source_term_mesh, std::unique_ptr< NumLib::LocalToGlobalIndexMap > source_term_dof_table, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, unsigned const integration_order, unsigned const shapefunction_order)
std::string	parseDirichletBCConfig (BaseLib::ConfigTree const &config)
std::unique_ptr< DirichletBoundaryCondition >	createDirichletBoundaryCondition (std::string const &parameter_name, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, int const variable_id, int const component_id, const std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &parameters)
void	checkParametersOfDirichletBoundaryCondition (MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, int const variable_id, int const component_id)
void	getEssentialBCValuesLocal (ParameterLib::Parameter< double > const &parameter, MeshLib::Mesh const &bc_mesh, std::vector< std::size_t > const &nodes_in_bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_boundary, int const variable_id, int const component_id, const double t, GlobalVector const &, NumLib::IndexValueVector< GlobalIndexType > &bc_values)
void	getEssentialBCValuesLocal (ParameterLib::Parameter< double > const &parameter, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_boundary, int const variable_id, int const component_id, const double t, GlobalVector const &x, NumLib::IndexValueVector< GlobalIndexType > &bc_values)
template<int GlobalDim>
auto	nodeLocalIndices (std::size_t const i)
template<int GlobalDim>
Eigen::RowVectorXd	computeShapeMatrix (MeshLib::Element const &bulk_element, std::span< double const, 3 > const nat_coords)
template<int GlobalDim>
std::tuple< Eigen::VectorXd, Eigen::MatrixXd >	assembleLocalBJac (Eigen::Vector< double, GlobalDim > const &f, Eigen::Matrix< double, GlobalDim, GlobalDim > const &Df, std::vector< Eigen::RowVectorXd > const &shape_matrices, std::size_t const num_dof, std::array< std::size_t, 2 > const &nodes_per_element)
std::string	parseHCNonAdvectiveFreeComponentFlowBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< HCNonAdvectiveFreeComponentFlowBoundaryCondition >	createHCNonAdvectiveFreeComponentFlowBoundaryCondition (std::string const &boundary_permeability_name, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table, int const variable_id, int const component_id, unsigned const integration_order, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, unsigned const global_dim, Process const &process, unsigned const shapefunction_order)
NeumannBoundaryConditionConfig	parseNeumannBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< NeumannBoundaryCondition >	createNeumannBoundaryCondition (NeumannBoundaryConditionConfig const &config, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table, int const variable_id, int const component_id, unsigned const integration_order, unsigned const shapefunction_order, unsigned const global_dim, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
void	parsePhaseFieldIrreversibleDamageOracleBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< PhaseFieldIrreversibleDamageOracleBoundaryCondition >	createPhaseFieldIrreversibleDamageOracleBoundaryCondition (NumLib::LocalToGlobalIndexMap const &dof_table, MeshLib::Mesh const &mesh, int const variable_id, int const component_id)
PrimaryVariableConstraintDirichletBoundaryConditionConfig	parsePrimaryVariableConstraintDirichletBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< PrimaryVariableConstraintDirichletBoundaryCondition >	createPrimaryVariableConstraintDirichletBoundaryCondition (PrimaryVariableConstraintDirichletBoundaryConditionConfig const &config, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, int const variable_id, int const component_id, const std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &parameters)
template<typename BHEType>
std::unique_ptr< BHEInflowPythonBoundaryCondition< BHEType > >	createBHEInflowPythonBoundaryCondition (std::pair< GlobalIndexType, GlobalIndexType > &&in_out_global_indices, BHEType &bhe, BHEInflowPythonBoundaryConditionPythonSideInterface &py_bc_object)
void	bheInflowpythonBindBoundaryCondition (pybind11::module &m)
	Creates BHE Inflow Python bindings for the Python BC class.
std::unique_ptr< SourceTerm >	createPythonSourceTerm (BaseLib::ConfigTree const &config, MeshLib::Mesh const &source_term_mesh, std::unique_ptr< NumLib::LocalToGlobalIndexMap > dof_table, int const variable_id, int const component_id, unsigned const integration_order, unsigned const shapefunction_order, unsigned const global_dim, std::vector< std::reference_wrapper< ProcessVariable > > const &all_process_variables_for_this_process)
PythonBoundaryConditionConfig	parsePythonBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< PythonBoundaryCondition >	createPythonBoundaryCondition (PythonBoundaryConditionConfig const &config, MeshLib::Mesh const &boundary_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, MeshLib::Mesh const &bulk_mesh, int const variable_id, int const component_id, unsigned const integration_order, unsigned const shapefunction_order, std::vector< std::reference_wrapper< ProcessVariable > > const &all_process_variables_for_this_process)
	Creates a new PythonBoundaryCondition object.
void	pythonBindBoundaryCondition (pybind11::module &m)
	Creates Python bindings for the Python BC class.
RobinBoundaryConditionConfig	parseRobinBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< RobinBoundaryCondition >	createRobinBoundaryCondition (RobinBoundaryConditionConfig const &config, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table, int const variable_id, int const component_id, unsigned const integration_order, unsigned const shapefunction_order, unsigned const global_dim, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
SolutionDependentDirichletBoundaryConditionConfig	parseSolutionDependentDirichletBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< SolutionDependentDirichletBoundaryCondition >	createSolutionDependentDirichletBoundaryCondition (SolutionDependentDirichletBoundaryConditionConfig const &config, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk, int const variable_id, int const component_id, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
std::unique_ptr< NumLib::LocalToGlobalIndexMap >	createBoundaryDOFTable (int const variable_id, int const component_id, MeshLib::Mesh const &boundary_mesh, NumLib::LocalToGlobalIndexMap const &dof_table_bulk)
VariableDependentNeumannConfig	parseVariableDependentNeumannBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< VariableDependentNeumannBoundaryCondition >	createVariableDependentNeumannBoundaryCondition (VariableDependentNeumannConfig const &coefficients, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table, int const variable_id, int const component_id, unsigned const integration_order, unsigned const shapefunction_order, unsigned const global_dim, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters)
WellboreCompensateCoefficients	parseWellboreCompensateNeumannBoundaryCondition (BaseLib::ConfigTree const &config)
std::unique_ptr< WellboreCompensateNeumannBoundaryCondition >	createWellboreCompensateNeumannBoundaryCondition (WellboreCompensateCoefficients const &coefficients, MeshLib::Mesh const &bc_mesh, NumLib::LocalToGlobalIndexMap const &dof_table, int const variable_id, int const component_id, unsigned const integration_order, unsigned const shapefunction_order, unsigned const global_dim, std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &media)
template<int DisplacementDim>
InitialStress	createInitialStress (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, MeshLib::Mesh const &mesh, bool const mandatory_stress_type)
template InitialStress	createInitialStress< 2 > (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, MeshLib::Mesh const &mesh, bool const mandatory_stress_type)
template InitialStress	createInitialStress< 3 > (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, MeshLib::Mesh const &mesh, bool const mandatory_stress_type)
std::unique_ptr< CompareJacobiansJacobianAssembler >	createCompareJacobiansJacobianAssembler (BaseLib::ConfigTree const &config)
std::vector< double >	getCoupledLocalSolutions (std::vector< GlobalVector * > const &global_solutions, std::vector< std::vector< GlobalIndexType > > const &indices)
std::unique_ptr< AbstractJacobianAssembler >	createCentralDifferencesJacobianAssembler (BaseLib::ConfigTree const &config)
template<typename IsActive>
static std::pair< std::vector< std::size_t >, std::vector< std::size_t > >	extractInnerAndOuterNodes (MeshLib::Mesh const &mesh, MeshLib::Mesh const &sub_mesh, IsActive is_active)
static std::vector< std::vector< std::size_t > >	extractElementsAlongOuterNodes (MeshLib::Mesh const &mesh, MeshLib::Mesh const &sub_mesh, std::vector< std::size_t > const &outer_nodes)
static DeactivatedSubdomainMesh	createDeactivatedSubdomainMesh (MeshLib::Mesh const &mesh, std::unordered_set< int > const &deactivated_subdomain_material_ids)
static MathLib::PiecewiseLinearInterpolation	parseTimeIntervalOrCurve (std::optional< BaseLib::ConfigTree > const &time_interval_config, std::optional< std::string > const &curve_name, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
static std::pair< Eigen::Vector3d, Eigen::Vector3d >	parseLineSegment (BaseLib::ConfigTree const &config)
	Returns a line segment represented by its begin and end points.
static detail::Ball	parseBall (BaseLib::ConfigTree const &config)
	Returns a ball represented by its center and its radius.
DeactivatedSubdomain	createDeactivatedSubdomain (BaseLib::ConfigTree const &config, MeshLib::Mesh const &mesh, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
std::vector< DeactivatedSubdomain >	createDeactivatedSubdomains (BaseLib::ConfigTree const &config, MeshLib::Mesh const &mesh, std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &parameters, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &curves)
std::unique_ptr< AbstractJacobianAssembler >	createForwardDifferencesJacobianAssembler (BaseLib::ConfigTree const &config)
std::unique_ptr< AbstractJacobianAssembler >	createJacobianAssembler (std::optional< BaseLib::ConfigTree > const &config)
static std::unique_ptr< ProcessData >	makeProcessData (std::unique_ptr< NumLib::TimeStepAlgorithm > &&timestepper, NumLib::NonlinearSolverBase &nonlinear_solver, int const process_id, std::string process_name, Process &process, std::unique_ptr< NumLib::TimeDiscretization > &&time_disc, std::unique_ptr< NumLib::ConvergenceCriterion > &&conv_crit, bool const compensate_non_equilibrium_initial_residuum)
std::vector< std::unique_ptr< ProcessData > >	createPerProcessData (BaseLib::ConfigTree const &config, std::vector< std::unique_ptr< Process > > const &processes, std::map< std::string, std::unique_ptr< NumLib::NonlinearSolverBase > > const &nonlinear_solvers, bool const compensate_non_equilibrium_initial_residuum, std::vector< double > const &fixed_times_for_output)
std::unique_ptr< TimeLoop >	createTimeLoop (BaseLib::ConfigTree const &config, std::string const &output_directory, std::vector< std::unique_ptr< Process > > const &processes, std::map< std::string, std::unique_ptr< NumLib::NonlinearSolverBase > > const &nonlinear_solvers, std::vector< std::unique_ptr< MeshLib::Mesh > > &meshes, bool const compensate_non_equilibrium_initial_residuum)
	Builds a TimeLoop from the given configuration.
template<int DisplacementDim, int NPOINTS, typename N_Type, typename HMatrixType>
void	computeHMatrix (N_Type const &N, HMatrixType &H)
	Fills a H-matrix based on given shape function.
void	addProcessDataToMesh (NumLib::Time const &t, std::vector< GlobalVector * > const &xs, int const process_id, ProcessOutputData const &process_output_data, bool const output_secondary_variables, OutputDataSpecification const &process_output)
template<int dim, typename LAIntf>
void	computeCellAverages (CellAverageData &cell_average_data, std::vector< std::unique_ptr< LAIntf > > const &local_assemblers)
std::unique_ptr< OutputFormat >	createOutputFormat (std::string const &output_directory, OutputType const output_type, std::string prefix, std::string suffix, std::string const &data_mode, bool const compress_output, unsigned int const number_of_files, unsigned int const chunk_size_bytes)
Output	createOutput (OutputConfig &&oc, std::string const &output_directory, std::vector< std::unique_ptr< MeshLib::Mesh > > const &meshes)
std::vector< Output >	createOutput (const BaseLib::ConfigTree &config, std::string const &output_directory, std::vector< std::unique_ptr< MeshLib::Mesh > > &meshes)
std::vector< Output >	createOutputs (const BaseLib::ConfigTree &output_configs, std::string const &output_directory, std::vector< std::unique_ptr< MeshLib::Mesh > > &meshes)
OutputConfig	createOutputConfig (const BaseLib::ConfigTree &config, std::vector< std::unique_ptr< MeshLib::Mesh > > &meshes)
void	createSecondaryVariables (BaseLib::ConfigTree const &config, SecondaryVariableCollection &secondary_variables)
void	addBulkMeshPropertyToSubMesh (MeshLib::Mesh const &bulk_mesh, MeshLib::Mesh &sub_mesh, std::string const &property_name)
std::vector< double >	calculateUniqueFixedTimesForAllOutputs (std::vector< Output > const &outputs)
std::ostream &	operator<< (std::ostream &os, Output const &output)
std::ostream &	operator<< (std::ostream &os, PairRepeatEachSteps const &pair)
std::ostream &	operator<< (std::ostream &os, OutputDataSpecification const &o)
void	outputMeshVtk (std::string const &file_name, MeshLib::Mesh const &mesh, bool const compress_output, int const data_mode)
void	outputMeshVtk (OutputVTKFormat const &output_file, MeshLib::IO::PVDFile &pvd_file, MeshLib::Mesh const &mesh, double const t, int const timestep, int const iteration, bool const converged)
std::ostream &	operator<< (std::ostream &os, OutputFormat const &of)
ProcessOutputData	createProcessOutputData (Process const &process, std::size_t const n_processes, MeshLib::Mesh &output_mesh)
	Extracts data necessary for output from the given process.
template<typename LocalAssemblerCollection>
SecondaryVariableFunctions	makeExtrapolator (const unsigned num_components, NumLib::Extrapolator &extrapolator, LocalAssemblerCollection const &local_assemblers, typename NumLib::ExtrapolatableLocalAssemblerCollection< LocalAssemblerCollection >::IntegrationPointValuesMethod integration_point_values_method)
template<typename LocalAssemblerCollection, typename IPDataAccessor>
SecondaryVariableFunctions	makeExtrapolator2 (const unsigned num_components, NumLib::Extrapolator &extrapolator, LocalAssemblerCollection const &local_assemblers, IPDataAccessor &&accessor)
SubmeshResiduumOutputConfig	createSubmeshResiduumOutputConfig (BaseLib::ConfigTree const &config, std::string const &output_directory, std::vector< std::unique_ptr< MeshLib::Mesh > > &meshes)
void	setEquationSystem (ProcessData const &process_data)
void	preTimestepForAllProcesses (NumLib::Time const &t, double const dt, std::vector< std::unique_ptr< ProcessData > > const &per_process_data, std::vector< GlobalVector * > const &_process_solutions)
void	postTimestepForAllProcesses (NumLib::Time const &t, double const dt, std::vector< std::unique_ptr< ProcessData > > const &per_process_data, std::vector< GlobalVector * > const &process_solutions, std::vector< GlobalVector * > const &process_solutions_prev)
template<NumLib::ODESystemTag ODETag>
void	setTimeDiscretizedODESystem (ProcessData &process_data, NumLib::ODESystem< ODETag, NumLib::NonlinearSolverTag::Picard > &ode_sys)
void	setTimeDiscretizedODESystem (ProcessData &process_data)
std::pair< std::vector< GlobalVector * >, std::vector< GlobalVector * > >	setInitialConditions (NumLib::Time const &t0, std::vector< std::unique_ptr< ProcessData > > const &per_process_data)
void	calculateNonEquilibriumInitialResiduum (std::vector< std::unique_ptr< ProcessData > > const &per_process_data, std::vector< GlobalVector * > const &process_solutions, std::vector< GlobalVector * > const &process_solutions_prev)
NumLib::NonlinearSolverStatus	solveOneTimeStepOneProcess (std::vector< GlobalVector * > &x, std::vector< GlobalVector * > const &x_prev, std::size_t const timestep, double const t, double const delta_t, ProcessData const &process_data, std::vector< Output > const &outputs)
bool	computationOfChangeNeeded (NumLib::TimeStepAlgorithm const &timestep_algorithm, NumLib::Time const &time)
static NumLib::NonlinearSolverStatus	solveMonolithicProcess (const NumLib::Time &t, const double dt, const std::size_t timestep_id, ProcessData const &process_data, std::vector< GlobalVector * > &x, std::vector< GlobalVector * > const &x_prev, std::vector< Output > const &outputs)
GlobalVector	computeResiduum (double const dt, GlobalVector const &x, GlobalVector const &x_prev, GlobalMatrix const &M, GlobalMatrix const &K, GlobalVector const &b)
template<int GlobalDim, template< typename, int > class LocalAssemblerImplementation, typename LocalAssemblerInterface, IntegrationMethodProviderOrIntegrationOrder ProviderOrOrder, typename... ExtraCtorArgs>
void	createLocalAssemblers (std::vector< MeshLib::Element * > const &mesh_elements, NumLib::LocalToGlobalIndexMap const &dof_table, std::vector< std::unique_ptr< LocalAssemblerInterface > > &local_assemblers, ProviderOrOrder const &provider_or_order, ExtraCtorArgs &&... extra_ctor_args)
template<template< typename, int > class LocalAssemblerImplementation, typename LocalAssemblerInterface, IntegrationMethodProviderOrIntegrationOrder ProviderOrOrder, typename... ExtraCtorArgs>
void	createLocalAssemblers (const unsigned dimension, std::vector< MeshLib::Element * > const &mesh_elements, NumLib::LocalToGlobalIndexMap const &dof_table, std::vector< std::unique_ptr< LocalAssemblerInterface > > &local_assemblers, ProviderOrOrder const &provider_or_order, ExtraCtorArgs &&... extra_ctor_args)
template<int GlobalDim, template< typename, typename, int > class LocalAssemblerImplementation, typename LocalAssemblerInterface, IntegrationMethodProviderOrIntegrationOrder ProviderOrOrder, typename... ExtraCtorArgs>
void	createLocalAssemblersHM (std::vector< MeshLib::Element * > const &mesh_elements, NumLib::LocalToGlobalIndexMap const &dof_table, std::vector< std::unique_ptr< LocalAssemblerInterface > > &local_assemblers, ProviderOrOrder const &provider_or_order, ExtraCtorArgs &&... extra_ctor_args)
template<int GlobalDim, template< typename, typename, int > class LocalAssemblerImplementation, typename LocalAssemblerInterface, IntegrationMethodProviderOrIntegrationOrder ProviderOrOrder, typename... ExtraCtorArgs>
void	createLocalAssemblersStokes (std::vector< MeshLib::Element * > const &mesh_elements, NumLib::LocalToGlobalIndexMap const &dof_table, std::vector< std::unique_ptr< LocalAssemblerInterface > > &local_assemblers, ProviderOrOrder const &provider_or_order, ExtraCtorArgs &&... extra_ctor_args)
ProcessVariable &	findProcessVariable (std::vector< ProcessVariable > const &variables, BaseLib::ConfigTree const &pv_config, std::string const &tag)
std::vector< std::reference_wrapper< ProcessVariable > >	findProcessVariables (std::vector< ProcessVariable > const &variables, BaseLib::ConfigTree const &pv_config, std::initializer_list< std::string > tags)
std::vector< std::reference_wrapper< ProcessVariable > >	findProcessVariables (std::vector< ProcessVariable > const &variables, BaseLib::ConfigTree const &pv_config, std::string const &tag, bool const optional)
std::string_view	removeIPFieldDataNameSuffix (std::string_view const name)
	Removes the suffix '_ip' from the passed field name.
template<typename LocalAssemblersVector>
void	setIPDataInitialConditions (std::vector< std::unique_ptr< MeshLib::IntegrationPointWriter > > const &_integration_point_writer, MeshLib::Properties const &mesh_properties, LocalAssemblersVector &local_assemblers)
template<int DisplacementDim, typename IntegrationPointDataVector, typename IpData, typename MemberType>
std::vector< double > const &	getIntegrationPointDimMatrixData (IntegrationPointDataVector const &ip_data_vector, MemberType IpData::*const member, std::vector< double > &cache)
template<int DisplacementDim, typename IntegrationPointDataVector, typename Accessor>
std::vector< double > const &	getIntegrationPointDimMatrixData (IntegrationPointDataVector const &ip_data_vector, Accessor &&accessor, std::vector< double > &cache)
template<int DisplacementDim, typename IntegrationPointDataVector, typename IpData, typename MemberType>
std::vector< double > const &	getIntegrationPointKelvinVectorData (IntegrationPointDataVector const &ip_data_vector, MemberType IpData::*const member, std::vector< double > &cache)
template<int DisplacementDim, typename IntegrationPointDataVector, typename Accessor>
std::vector< double > const &	getIntegrationPointKelvinVectorData (IntegrationPointDataVector const &ip_data_vector, Accessor &&accessor, std::vector< double > &cache)
template<int DisplacementDim, typename IntegrationPointDataVector, typename MemberType>
std::vector< double >	getIntegrationPointKelvinVectorData (IntegrationPointDataVector const &ip_data_vector, MemberType member)
template<int DisplacementDim, typename IntegrationPointDataVector, typename IpData, typename MemberType>
std::size_t	setIntegrationPointKelvinVectorData (double const *values, IntegrationPointDataVector &ip_data_vector, MemberType IpData::*const member)
template<int DisplacementDim, typename IntegrationPointDataVector, typename Accessor>
std::size_t	setIntegrationPointKelvinVectorData (double const *values, IntegrationPointDataVector &ip_data_vector, Accessor &&accessor)
template<typename IntegrationPointDataVector, typename IpData, typename MemberType>
std::vector< double > const &	getIntegrationPointScalarData (IntegrationPointDataVector const &ip_data_vector, MemberType IpData::*const member, std::vector< double > &cache)
template<typename IntegrationPointDataVector, typename Accessor>
std::vector< double > const &	getIntegrationPointScalarData (IntegrationPointDataVector const &ip_data_vector, Accessor &&accessor, std::vector< double > &cache)
template<typename IntegrationPointDataVector, typename IpData, typename MemberType>
std::size_t	setIntegrationPointScalarData (double const *values, IntegrationPointDataVector &ip_data_vector, MemberType IpData::*const member)
template<typename IntegrationPointDataVector, typename Accessor>
std::size_t	setIntegrationPointScalarData (double const *values, IntegrationPointDataVector &ip_data_vector, Accessor &&accessor)
template<typename IntegrationPointDataVector, typename MemberType, typename MaterialStateVariables>
std::vector< double >	getIntegrationPointDataMaterialStateVariables (IntegrationPointDataVector const &ip_data_vector, MemberType member, std::function< std::span< double >(MaterialStateVariables &)> get_values_span, int const n_components)
template<typename IntegrationPointDataVector, typename MemberType, typename MaterialStateVariables>
std::size_t	setIntegrationPointDataMaterialStateVariables (double const *values, IntegrationPointDataVector &ip_data_vector, MemberType member, std::function< std::span< double >(MaterialStateVariables &)> get_values_span)
template<int Components, typename StoreValuesFunction>
std::vector< double >	transposeInPlace (StoreValuesFunction const &store_values_function)
template<int Components>
void	transposeInPlace (std::vector< double > &values)
void	transposeInPlace (std::vector< double > &values, unsigned const num_components)

Variables
static constexpr std::string_view	timestepper_cannot_reduce_dt

Typedef Documentation

EnabledElementTraitsLagrange

using ProcessLib::EnabledElementTraitsLagrange

Initial value:

 
    decltype(BaseLib::TMP::filter<NumLib::AllElementTraitsLagrange>(
        detail::isElementEnabled))

List of all element types for which the local assemblers of OGS processes will be compiled.

Definition at line 112 of file EnabledElements.h.

HCNonAdvectiveFreeComponentFlowBoundaryCondition

using ProcessLib::HCNonAdvectiveFreeComponentFlowBoundaryCondition

Initial value:

 
    GenericNaturalBoundaryCondition<
        HCNonAdvectiveFreeComponentFlowBoundaryConditionData,
        HCNonAdvectiveFreeComponentFlowBoundaryConditionLocalAssembler>

Definition at line 12 of file HCNonAdvectiveFreeComponentFlowBoundaryCondition.h.

LocalAssemblerFactory

template<typename LocalAssemblerInterface, template< typename, int > class LocalAssemblerImplementation, NumLib::IntegrationMethodProvider IntegrationMethodProvider, int GlobalDim, typename... ConstructorArgs>

using ProcessLib::LocalAssemblerFactory

Initial value:

 
    LocalAssemblerFactoryForDimGreaterEqualN<1,
                                             LocalAssemblerInterface,
                                             LocalAssemblerImplementation,
                                             IntegrationMethodProvider,
                                             GlobalDim,
                                             ConstructorArgs...>

By default processes in OGS are defined in 1D, 2D and 3D.

Definition at line 82 of file LocalAssemblerFactoryForDimGreaterEqualN.h.

LocalAssemblerFactoryHM

template<typename LocalAssemblerInterface, template< typename, typename, int > class LocalAssemblerImplementation, NumLib::IntegrationMethodProvider IntegrationMethodProvider, int GlobalDim, typename... ConstructorArgs>

using ProcessLib::LocalAssemblerFactoryHM

Initial value:

 
    LocalAssemblerFactoryTaylorHood<1 ,
                                    2 ,
                                    LocalAssemblerInterface,
                                    LocalAssemblerImplementation,
                                    IntegrationMethodProvider,
                                    GlobalDim,
                                    ConstructorArgs...>

HM processes in OGS are defined for linear and higher order elements.

Definition at line 167 of file LocalAssemblerFactoryTaylorHood.h.

LocalAssemblerFactorySD

template<typename LocalAssemblerInterface, template< typename, int > class LocalAssemblerImplementation, NumLib::IntegrationMethodProvider IntegrationMethodProvider, int GlobalDim, typename... ConstructorArgs>

using ProcessLib::LocalAssemblerFactorySD

Initial value:

 
    LocalAssemblerFactoryForDimGreaterEqualN<2,
                                             LocalAssemblerInterface,
                                             LocalAssemblerImplementation,
                                             IntegrationMethodProvider,
                                             GlobalDim,
                                             ConstructorArgs...>

Mechanics processes in OGS are defined in 2D and 3D only.

Definition at line 97 of file LocalAssemblerFactoryForDimGreaterEqualN.h.

LocalAssemblerFactoryStokes

template<typename LocalAssemblerInterface, template< typename, typename, int > class LocalAssemblerImplementation, NumLib::IntegrationMethodProvider IntegrationMethodProvider, int GlobalDim, typename... ConstructorArgs>

using ProcessLib::LocalAssemblerFactoryStokes

Initial value:

 
    LocalAssemblerFactoryTaylorHood<2 ,
                                    2 ,
                                    LocalAssemblerInterface,
                                    LocalAssemblerImplementation,
                                    IntegrationMethodProvider,
                                    GlobalDim,
                                    ConstructorArgs...>

Stokes flow in OGS is defined for higher order elements only.

Definition at line 185 of file LocalAssemblerFactoryTaylorHood.h.

LocalAssemblerTraits

template<typename ShpPol, unsigned NNodes, unsigned NodalDOF, int Dim>

using ProcessLib::LocalAssemblerTraits

Initial value:

 
    detail::LocalAssemblerTraitsFixed<ShpPol, NNodes, NodalDOF, Dim>

Definition at line 178 of file LocalAssemblerTraits.h.

NeumannBoundaryCondition

using ProcessLib::NeumannBoundaryCondition

Initial value:

 
    GenericNaturalBoundaryCondition<NeumannBoundaryConditionData,
                                    NeumannBoundaryConditionLocalAssembler>

Definition at line 18 of file NeumannBoundaryCondition.h.

RobinBoundaryCondition

using ProcessLib::RobinBoundaryCondition

Initial value:

 
    GenericNaturalBoundaryCondition<RobinBoundaryConditionData,
                                    RobinBoundaryConditionLocalAssembler>

Definition at line 22 of file RobinBoundaryCondition.h.

Trafo

using ProcessLib::Trafo = ProcessLib::TrafoScale

Definition at line 77 of file VariableTransformation.h.

VariableDependentNeumannBoundaryCondition

using ProcessLib::VariableDependentNeumannBoundaryCondition

Initial value:

 
    GenericNaturalBoundaryCondition<
        VariableDependentNeumannBoundaryConditionData,
        VariableDependentNeumannBoundaryConditionLocalAssembler>

Definition at line 12 of file VariableDependentNeumannBoundaryCondition.h.

WellboreCompensateNeumannBoundaryCondition

using ProcessLib::WellboreCompensateNeumannBoundaryCondition

Initial value:

 
    GenericNaturalBoundaryCondition<
        WellboreCompensateNeumannBoundaryConditionData,
        WellboreCompensateNeumannBoundaryConditionLocalAssembler>

Definition at line 13 of file WellboreCompensateNeumannBoundaryCondition.h.

Enumeration Type Documentation

OutputType

enum class ProcessLib::OutputType : uint8_t

strong

Enumerator
vtk
xdmf

Definition at line 14 of file OutputConfig.h.

{
    vtk,
    xdmf
};

Function Documentation

addBulkMeshPropertyToSubMesh()

void ProcessLib::addBulkMeshPropertyToSubMesh	(	MeshLib::Mesh const &	bulk_mesh,
		MeshLib::Mesh &	sub_mesh,
		std::string const &	property_name )

Definition at line 25 of file ProcessLib/Output/Output.cpp.

{
    if (bulk_mesh == sub_mesh)
    {
        return;
    }
 
    if (!bulk_mesh.getProperties().existsPropertyVector<double>(
            std::string_view(property_name)))
    {
        return;
    }
    auto const& bulk_mesh_property =
        *bulk_mesh.getProperties().getPropertyVector<double>(
            std::string_view(property_name));
    auto const mesh_item_type = bulk_mesh_property.getMeshItemType();
 
    std::string_view mesh_item_type_string =
        [mesh_item_type, &property_name]() -> std::string_view
    {
        switch (mesh_item_type)
        {
            case MeshLib::MeshItemType::Node:
                return MeshLib::getBulkIDString(MeshLib::MeshItemType::Node);
                break;
            case MeshLib::MeshItemType::Cell:
                return MeshLib::getBulkIDString(MeshLib::MeshItemType::Cell);
                break;
            case MeshLib::MeshItemType::Edge:
                WARN(
                    "Property '{}' is assigned to edges. But mappings from the "
                    "bulk edges to submesh edges isn't implemented. Mesh item "
                    "type 'Edge' is not supported, only 'Node' and 'Cell' are "
                    "implemented at the moment.",
                    property_name);
                return "";
                break;
            case MeshLib::MeshItemType::Face:
                WARN(
                    "Property '{}' is assigned to faces. But mappings from the "
                    "bulk faces to submesh faces isn't implemented. Mesh item "
                    "type 'Face' is not supported, only 'Node' and 'Cell' are "
                    "implemented at the moment.",
                    property_name);
                return "";
                break;
            case MeshLib::MeshItemType::IntegrationPoint:
                WARN(
                    "Property '{}' is assigned to integration points. But "
                    "mappings from the bulk integration points to submesh "
                    "integration points isn't implemented. Mesh item type "
                    "'IntegrationPoint' is not supported, only 'Node' and "
                    "'Cell' are implemented at the moment.",
                    property_name);
                return "";
                break;
            default:
                OGS_FATAL("Unknown mesh item type '{}'.",
                          static_cast<int>(mesh_item_type));
                return "";
        }
    }();
 
    if (mesh_item_type_string.empty())
    {
        return;
    }
    if (!sub_mesh.getProperties().existsPropertyVector<std::size_t>(
            mesh_item_type_string, mesh_item_type, 1))
    {
        WARN(
            "The property {} is required for output on the mesh {}, but it "
            "doesn't exist.",
            mesh_item_type_string, sub_mesh.getName());
        return;
    }
 
    auto const& bulk_ids =
        *sub_mesh.getProperties().getPropertyVector<std::size_t>(
            mesh_item_type_string);
 
    auto const number_of_components =
        bulk_mesh_property.getNumberOfGlobalComponents();
    auto& sub_mesh_property = *MeshLib::getOrCreateMeshProperty<double>(
        sub_mesh, property_name, mesh_item_type, number_of_components);
 
    for (std::size_t sub_mesh_node_id = 0;
         sub_mesh_node_id < bulk_ids.getNumberOfTuples();
         ++sub_mesh_node_id)
    {
        auto const& bulk_id = bulk_ids[sub_mesh_node_id];
        for (std::remove_cv_t<decltype(number_of_components)> c = 0;
             c < number_of_components;
             ++c)
        {
            sub_mesh_property.getComponent(sub_mesh_node_id, c) =
                bulk_mesh_property.getComponent(bulk_id, c);
        }
    }
}

References MeshLib::Cell, MeshLib::Edge, MeshLib::Properties::existsPropertyVector(), MeshLib::Face, MeshLib::getBulkIDString(), MeshLib::PropertyVectorBase::getMeshItemType(), MeshLib::Mesh::getName(), MeshLib::PropertyVectorBase::getNumberOfGlobalComponents(), MeshLib::getOrCreateMeshProperty(), MeshLib::Mesh::getProperties(), MeshLib::Properties::getPropertyVector(), MeshLib::IntegrationPoint, MeshLib::Node, OGS_FATAL, and WARN().

Referenced by ProcessLib::Output::prepareSubmesh().

addProcessDataToMesh()

void ProcessLib::addProcessDataToMesh	(	NumLib::Time const &	t,
		std::vector< GlobalVector * > const &	xs,
		int const	process_id,
		ProcessOutputData const &	process_output_data,
		bool const	output_secondary_variables,
		OutputDataSpecification const &	process_output )

Adds output data to a mesh.

Note

The mesh is passed via process_output_data.

Definition at line 370 of file AddProcessDataToMesh.cpp.

{
    DBUG("Process output data.");
 
    auto const& pod = process_output_data;
    auto const& process_variables = pod.getProcessVariables(process_id);
    auto const& secondary_variables = pod.getSecondaryVariables();
    auto const* const integration_point_writers =
        pod.getIntegrationPointWriters();
    auto const& bulk_mesh_dof_table = pod.getBulkMeshDofTable(process_id);
    auto const& output_mesh_dof_table = pod.getOutputMeshDofTable(process_id);
    auto& output_mesh = pod.getOutputMesh();
 
    auto const& output_variables = process_output.output_variables;
 
    addOgsVersion(output_mesh);
 
    auto names_of_already_output_variables = addPrimaryVariablesToMesh(
        output_mesh, *xs[process_id], process_variables, output_variables,
        output_mesh_dof_table, bulk_mesh_dof_table);
 
    if (output_secondary_variables)
    {
        auto const& output_mesh_dof_tables =
            pod.getOutputMeshDofTablesOfAllProcesses();
 
        addSecondaryVariablesToMesh(secondary_variables,
                                    names_of_already_output_variables, t, xs,
                                    output_mesh, output_mesh_dof_tables,
                                    process_output.output_residuals);
    }
 
    if (integration_point_writers)
    {
        addIntegrationPointDataToMesh(output_mesh, *integration_point_writers);
    }
}

References addOgsVersion(), addPrimaryVariablesToMesh(), addSecondaryVariablesToMesh(), DBUG(), ProcessLib::ProcessOutputData::getProcessVariables(), ProcessLib::OutputDataSpecification::output_residuals, and ProcessLib::OutputDataSpecification::output_variables.

Referenced by ProcessLib::Output::doOutputAlways(), ProcessLib::Output::doOutputNonlinearIteration(), and ProcessLib::Output::prepareSubmesh().

assembleLocalBJac()

template<int GlobalDim>

std::tuple< Eigen::VectorXd, Eigen::MatrixXd > ProcessLib::assembleLocalBJac	(	Eigen::Vector< double, GlobalDim > const &	f,
		Eigen::Matrix< double, GlobalDim, GlobalDim > const &	Df,
		std::vector< Eigen::RowVectorXd > const &	shape_matrices,
		std::size_t const	num_dof,
		std::array< std::size_t, 2 > const &	nodes_per_element )

Definition at line 77 of file EmbeddedAnchor.cpp.

{
    // Signs for the two nodes alternate.
    constexpr auto even_odd_sign = [](std::size_t const n)
    { return (n % 2 == 0) ? 1.0 : -1.0; };
 
    Eigen::VectorXd local_rhs(num_dof);
    Eigen::MatrixXd local_Jac(num_dof, num_dof);
    local_rhs.setZero();
    local_Jac.setZero();
 
    for (std::size_t node_idx = 0; node_idx < 2; ++node_idx)
    {
        // Select the correct block according to the node index.
        // Replicate shape matrices of the corresponding element to GlobalDim
        // dimensions. Multiply component-wise with the force vector f.
        local_rhs.segment(node_idx * GlobalDim * nodes_per_element[0],
                          GlobalDim * nodes_per_element[node_idx]) =
            even_odd_sign(node_idx) *
            shape_matrices[node_idx]
                .transpose()
                .replicate<GlobalDim, 1>()
                .cwiseProduct(f.transpose()
                                  .replicate(nodes_per_element[node_idx], 1)
                                  .reshaped());
        for (std::size_t node_idx_inner = 0; node_idx_inner < 2;
             ++node_idx_inner)
        {
            Eigen::MatrixXd const& ones = Eigen::MatrixXd::Ones(
                nodes_per_element[node_idx], nodes_per_element[node_idx_inner]);
 
            // Select the correct block according to the node index.
            // Replicate shape matrices of the corresponding element to
            // GlobalDim dimensions. Multiply component-wise with the derivative
            // Df of force vector f.
            local_Jac.block(node_idx * GlobalDim * nodes_per_element[0],
                            node_idx_inner * GlobalDim * nodes_per_element[0],
                            GlobalDim * nodes_per_element[node_idx],
                            GlobalDim * nodes_per_element[node_idx_inner]) =
                (even_odd_sign(node_idx) *
                 shape_matrices[node_idx]
                     .transpose()
                     .replicate<GlobalDim, 1>() *
                 even_odd_sign(node_idx_inner) *
                 shape_matrices[node_idx_inner].replicate<1, GlobalDim>())
                    .cwiseProduct(kroneckerProduct(Df, ones));
        }
    }
    return {local_rhs, local_Jac};
}

Referenced by ProcessLib::EmbeddedAnchor< GlobalDim >::integrate().

bheInflowpythonBindBoundaryCondition()

OGS_EXPORT_SYMBOL void ProcessLib::bheInflowpythonBindBoundaryCondition

(

pybind11::module &

m

)

Creates BHE Inflow Python bindings for the Python BC class.

Definition at line 69 of file BHEInflowPythonBoundaryConditionModule.cpp.

{
    namespace py = pybind11;
 
    py::class_<BHEInflowPythonBoundaryConditionPythonSideInterface,
               BHEInflowPythonBoundaryConditionPythonSideInterfaceTrampoline>
        pybc(m, "BHENetwork");
 
    pybc.def(py::init());
 
    pybc.def("initializeDataContainer",
             &BHEInflowPythonBoundaryConditionPythonSideInterface::
                 initializeDataContainer);
    pybc.def("tespySolver",
             &BHEInflowPythonBoundaryConditionPythonSideInterface::tespySolver);
 
    pybc.def("serverCommunicationPreTimestep",
             &BHEInflowPythonBoundaryConditionPythonSideInterface::
                 serverCommunicationPreTimestep);
 
    pybc.def("serverCommunicationPostTimestep",
             &BHEInflowPythonBoundaryConditionPythonSideInterface::
                 serverCommunicationPostTimestep);
}

References ProcessLib::BHEInflowPythonBoundaryConditionPythonSideInterface::tespySolver().

Referenced by PYBIND11_EMBEDDED_MODULE(), and PYBIND11_MODULE().

calculateNonEquilibriumInitialResiduum()

void ProcessLib::calculateNonEquilibriumInitialResiduum	(	std::vector< std::unique_ptr< ProcessData > > const &	per_process_data,
		std::vector< GlobalVector * > const &	process_solutions,
		std::vector< GlobalVector * > const &	process_solutions_prev )

Definition at line 201 of file TimeLoop.cpp.

{
    for (auto const& process_data : per_process_data)
    {
        auto& nonlinear_solver = process_data->nonlinear_solver;
 
        setEquationSystem(*process_data);
        nonlinear_solver.calculateNonEquilibriumInitialResiduum(
            process_solutions, process_solutions_prev,
            process_data->process_id);
    }
}

References setEquationSystem().

Referenced by ProcessLib::TimeLoop::initialize().

calculateUniqueFixedTimesForAllOutputs()

std::vector< double > ProcessLib::calculateUniqueFixedTimesForAllOutputs

(

std::vector< Output > const &

outputs

)

Definition at line 434 of file ProcessLib/Output/Output.cpp.

{
    std::vector<double> fixed_times;
    for (auto const& output : outputs)
    {
        auto const& output_fixed_times = output.getFixedOutputTimes();
        fixed_times.insert(fixed_times.end(), output_fixed_times.begin(),
                           output_fixed_times.end());
    }
    BaseLib::makeVectorUnique(fixed_times);
    return fixed_times;
}

References BaseLib::makeVectorUnique().

Referenced by ProcessLib::TimeLoop::calculateNextTimeStep(), createTimeLoop(), and ProcessLib::TimeLoop::initialize().

checkParametersOfDirichletBoundaryCondition()

void ProcessLib::checkParametersOfDirichletBoundaryCondition	(	MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		int const	variable_id,
		int const	component_id )

Definition at line 16 of file DirichletBoundaryConditionAuxiliaryFunctions.cpp.

{
    if (variable_id >=
            static_cast<int>(dof_table_bulk.getNumberOfVariables()) ||
        component_id >=
            dof_table_bulk.getNumberOfVariableComponents(variable_id))
    {
        OGS_FATAL(
            "Variable id or component id too high. Actual values: ({:d}, "
            "{:d}), maximum values: ({:d}, {:d}).",
            variable_id, component_id, dof_table_bulk.getNumberOfVariables(),
            dof_table_bulk.getNumberOfVariableComponents(variable_id));
    }
 
    if (!bc_mesh.getProperties().hasPropertyVector(
            std::string(MeshLib::getBulkIDString(MeshLib::MeshItemType::Node))))
    {
        OGS_FATAL(
            "The required bulk node ids map does not exist in the boundary "
            "mesh '{:s}'.",
            bc_mesh.getName());
    }
 
    if (!bc_mesh.getProperties().existsPropertyVector<std::size_t>(
            MeshLib::getBulkIDString(MeshLib::MeshItemType::Node)))
    {
        OGS_FATAL(
            "The required bulk node ids map exists in the boundary mesh '{:s}' "
            "but has wrong data type (should be equivalent to C++ data type "
            "std::size_t which is an unsigned integer of size {:d} or UInt64 "
            "in vtk terminology).",
            bc_mesh.getName(), sizeof(std::size_t));
    }
 
    DBUG(
        "Found {:d} nodes for Dirichlet BCs for the variable {:d} and "
        "component {:d}",
        bc_mesh.getNumberOfNodes(), variable_id, component_id);
}

References DBUG(), MeshLib::Properties::existsPropertyVector(), MeshLib::getBulkIDString(), MeshLib::Mesh::getName(), MeshLib::Mesh::getNumberOfNodes(), NumLib::LocalToGlobalIndexMap::getNumberOfVariableComponents(), NumLib::LocalToGlobalIndexMap::getNumberOfVariables(), MeshLib::Mesh::getProperties(), MeshLib::Properties::hasPropertyVector(), MeshLib::Node, and OGS_FATAL.

Referenced by ProcessLib::DirichletBoundaryCondition::DirichletBoundaryCondition(), ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::PrimaryVariableConstraintDirichletBoundaryCondition(), ProcessLib::SolutionDependentDirichletBoundaryCondition::SolutionDependentDirichletBoundaryCondition(), ProcessLib::DeactivatedSubdomainDirichlet::config(), ProcessLib::DirichletBoundaryConditionWithinTimeInterval::config(), and createBoundaryDOFTable().

computationOfChangeNeeded()

bool ProcessLib::computationOfChangeNeeded	(	NumLib::TimeStepAlgorithm const &	timestep_algorithm,
		NumLib::Time const &	time )

Definition at line 277 of file TimeLoop.cpp.

{
    // for the first time step we can't compute the changes to the previous
    // time step
    if (time == timestep_algorithm.begin())
    {
        return false;
    }
    return timestep_algorithm.isSolutionErrorComputationNeeded();
}

References NumLib::TimeStepAlgorithm::begin(), and NumLib::TimeStepAlgorithm::isSolutionErrorComputationNeeded().

Referenced by ProcessLib::TimeLoop::computeTimeStepping().

computeCellAverages()

template<int dim, typename LAIntf>

void ProcessLib::computeCellAverages	(	CellAverageData &	cell_average_data,
		std::vector< std::unique_ptr< LAIntf > > const &	local_assemblers )

Definition at line 38 of file CellAverageAlgorithm.h.

{
    auto const callback = [&cell_average_data, &local_assemblers](
                              std::string const& name,
                              unsigned const num_comp,
                              auto&& flattened_ip_data_accessor)
    {
        detail::computeCellAverages(cell_average_data, name, num_comp,
                                    flattened_ip_data_accessor,
                                    local_assemblers);
    };
 
    ProcessLib::Reflection::forEachReflectedFlattenedIPDataAccessor<dim,
                                                                    LAIntf>(
        LAIntf::getReflectionDataForOutput(), callback);
}

References ProcessLib::detail::computeCellAverages(), and ProcessLib::Reflection::forEachReflectedFlattenedIPDataAccessor().

Referenced by ProcessLib::LargeDeformation::LargeDeformationProcess< DisplacementDim >::computeSecondaryVariableConcrete(), ProcessLib::SmallDeformation::SmallDeformationProcess< DisplacementDim >::computeSecondaryVariableConcrete(), ProcessLib::TH2M::TH2MProcess< DisplacementDim >::computeSecondaryVariableConcrete(), and ProcessLib::ThermoRichardsMechanics::ThermoRichardsMechanicsProcess< DisplacementDim, ConstitutiveTraits >::computeSecondaryVariableConcrete().

computeHMatrix()

template<int DisplacementDim, int NPOINTS, typename N_Type, typename HMatrixType>

void ProcessLib::computeHMatrix	(	N_Type const &	N,
		HMatrixType &	H )

Fills a H-matrix based on given shape function.

Definition at line 46 of file HMatrixUtils.h.

{
    static_assert(1 < DisplacementDim && DisplacementDim <= 3,
                  "LinearHMatrix::computeHMatrix: DisplacementDim must be in "
                  "range (1,3].");
 
    H.setZero();
 
    for (int j = 0; j < DisplacementDim; j++)
    {
        H.block(j, j * NPOINTS, 1, NPOINTS) = N;
    }
}

Referenced by ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerFracture< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::HydroMechanicsLocalAssemblerFracture(), and ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerFracture< ShapeFunction, DisplacementDim >::SmallDeformationLocalAssemblerFracture().

computeResiduum()

GlobalVector ProcessLib::computeResiduum	(	double const	dt,
		GlobalVector const &	x,
		GlobalVector const &	x_prev,
		GlobalMatrix const &	M,
		GlobalMatrix const &	K,
		GlobalVector const &	b )

Computes the residuum r = -M*x_dot - K*x + b. Negation for consistency with the Newton scheme.

Definition at line 10 of file ComputeResiduum.cpp.

{
    using namespace MathLib::LinAlg;
    GlobalVector residuum;
    GlobalVector x_dot;
    copy(x, x_dot);                        // tmp = x
    axpy(x_dot, -1., x_prev);              // tmp = x - x_prev
    scale(x_dot, 1. / dt);                 // tmp = (x - x_prev)/dt
    matMult(M, x_dot, residuum);           // r = M*x_dot
    matMultAdd(K, x, residuum, residuum);  // r = M*x_dot + K*x
    axpy(residuum, -1., b);                // r = M*x_dot + K*x - b
    scale(residuum, -1.);                  // r = -r
    return residuum;
}

References MathLib::LinAlg::axpy(), MathLib::LinAlg::copy(), MathLib::LinAlg::matMult(), MathLib::LinAlg::matMultAdd(), and MathLib::LinAlg::scale().

Referenced by ProcessLib::AssemblyMixin< Process >::assemble(), ProcessLib::LiquidFlow::LiquidFlowProcess::assembleConcreteProcess(), and ProcessLib::AssemblyMixin< Process >::assembleOnSubmeshes().

computeShapeMatrix()

template<int GlobalDim>

Eigen::RowVectorXd ProcessLib::computeShapeMatrix	(	MeshLib::Element const &	bulk_element,
		std::span< double const, 3 > const	nat_coords )

Definition at line 33 of file EmbeddedAnchor.cpp.

{
    using ShapeMatricesType =
        EigenDynamicShapeMatrixPolicy<void /* dummy */, -1 /* dynamic order */>;
 
    typename ShapeMatricesType::ShapeMatrices shape_matrix(
        bulk_element.getDimension(), GlobalDim,
        bulk_element.getNumberOfNodes());
 
    bool matched = false;
 
    BaseLib::TMP::foreach<NumLib::AllElementTraitsLagrange>(
        [&](auto* tag)
        {
            using ElementTrait = std::remove_pointer_t<decltype(tag)>;
            using ShapeFunction = typename ElementTrait::ShapeFunction;
            using MeshElement = typename ElementTrait::Element;
 
            if (!matched &&
                dynamic_cast<MeshElement const*>(&bulk_element) != nullptr)
            {
                auto const fe = NumLib::createIsoparametricFiniteElement<
                    ShapeFunction, ShapeMatricesType>(bulk_element);
 
                fe.template computeShapeFunctions<NumLib::ShapeMatrixType::N>(
                    nat_coords.data(), shape_matrix, GlobalDim,
                    false /* axisymmetric */);
 
                matched = true;
            }
        });
 
    if (!matched)
    {
        OGS_FATAL("Element type '{:s}' is not supported as anchor element.",
                  MeshLib::CellType2String(bulk_element.getCellType()));
    }
 
    return shape_matrix.N;
}

References MeshLib::CellType2String(), NumLib::createIsoparametricFiniteElement(), BaseLib::TMP::foreach(), MeshLib::Element::getCellType(), MeshLib::Element::getDimension(), MeshLib::Element::getNumberOfNodes(), and OGS_FATAL.

Referenced by ProcessLib::EmbeddedAnchor< GlobalDim >::getShapeMatricesAndGlobalIndicesAndDisplacements().

createAnchorTerm()

template<int GlobalDim>

std::unique_ptr< SourceTerm > ProcessLib::createAnchorTerm	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	st_mesh,
		std::unique_ptr< NumLib::LocalToGlobalIndexMap >	dof_table,
		std::size_t const	source_term_mesh_id,
		const int	variable_id,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__type

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__Anchor__anchor_force_constant

Definition at line 14 of file CreateAnchorTerm.cpp.

{
    DBUG("Constructing AnchorTerm from config.");
    config.checkConfigParameter("type", "Anchor");
 
    auto const param_name =
        config.getConfigParameter<std::string>("anchor_force_constant");
    DBUG("Using parameter {:s} as anchor stiffness constant.", param_name);
 
    auto& param = ParameterLib::findParameter<double>(param_name, parameters, 1,
                                                      &st_mesh);
 
    for (MeshLib::Element const* const element : st_mesh.getElements())
    {
        if (element->getNumberOfNodes() != 2)
        {
            OGS_FATAL(
                "Every anchor element needs to have precisely two nodes.");
        }
    }
 
    return std::make_unique<AnchorTerm<GlobalDim>>(
        std::move(dof_table), source_term_mesh_id, st_mesh, variable_id, param);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), MeshLib::Mesh::getElements(), and OGS_FATAL.

createAnchorTerm< 2 >()

template std::unique_ptr< SourceTerm > ProcessLib::createAnchorTerm< 2 >	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	st_mesh,
		std::unique_ptr< NumLib::LocalToGlobalIndexMap >	dof_table,
		std::size_t const	source_term_mesh_id,
		const int	variable_id,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Referenced by createSourceTerm().

createAnchorTerm< 3 >()

template std::unique_ptr< SourceTerm > ProcessLib::createAnchorTerm< 3 >	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	st_mesh,
		std::unique_ptr< NumLib::LocalToGlobalIndexMap >	dof_table,
		std::size_t const	source_term_mesh_id,
		const int	variable_id,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Referenced by createSourceTerm().

createBHEInflowPythonBoundaryCondition()

template<typename BHEType>

std::unique_ptr< BHEInflowPythonBoundaryCondition< BHEType > > ProcessLib::createBHEInflowPythonBoundaryCondition	(	std::pair< GlobalIndexType, GlobalIndexType > &&	in_out_global_indices,
		BHEType &	bhe,
		BHEInflowPythonBoundaryConditionPythonSideInterface &	py_bc_object )

Definition at line 88 of file BHEInflowPythonBoundaryCondition.h.

{
    DBUG("Constructing BHEInflowPythonBoundaryCondition.");
 
    // In case of partitioned mesh the boundary could be empty, i.e. there is no
    // boundary condition.
#ifdef USE_PETSC
    // For this special boundary condition the boundary condition is not empty
    // if the global indices are non-negative.
    if (in_out_global_indices.first < 0 && in_out_global_indices.second < 0)
    {
        return nullptr;
    }
    // If only one of the global indices (in or out) is negative the
    // implementation is not valid.
    if (in_out_global_indices.first < 0 || in_out_global_indices.second < 0)
    {
        OGS_FATAL(
            "The partition cuts the BHE into two independent parts. This "
            "behaviour is not implemented.");
    }
#endif  // USE_PETSC
    return std::make_unique<BHEInflowPythonBoundaryCondition<BHEType>>(
        std::move(in_out_global_indices), bhe, py_bc_object);
}

References DBUG(), and OGS_FATAL.

Referenced by ProcessLib::HeatTransportBHE::HeatTransportBHEProcess::createBHEBoundaryConditionTopBottom().

createBoundaryCondition()

std::vector< std::unique_ptr< BoundaryCondition > > ProcessLib::createBoundaryCondition	(	const BoundaryConditionConfig &	config,
		const NumLib::LocalToGlobalIndexMap &	dof_table,
		const MeshLib::Mesh &	bulk_mesh,
		const int	variable_id,
		const unsigned	integration_order,
		const unsigned	shapefunction_order,
		const std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &	parameters,
		const Process &	process,
		std::vector< std::reference_wrapper< ProcessVariable > > const &	all_process_variables_for_this_process,
		std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &	media )

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__PhaseFieldIrreversibleDamageOracleBoundaryCondition

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__ReleaseNodalForce

Definition at line 30 of file CreateBoundaryCondition.cpp.

{
    // Surface mesh and bulk mesh must have equal axial symmetry flags!
    for (auto const& i : config.boundary_meshes)
    {
        if (i.get().isAxiallySymmetric() != bulk_mesh.isAxiallySymmetric())
        {
            OGS_FATAL(
                "The boundary mesh {:s} axially symmetric but the bulk mesh "
                "{:s}. "
                "Both must have an equal axial symmetry property.",
                i.get().isAxiallySymmetric() ? "is" : "is not",
                bulk_mesh.isAxiallySymmetric() ? "is" : "is not");
        }
    }
 
    std::vector<std::unique_ptr<BoundaryCondition>> boundary_conditions;

    auto const type = config.config.peekConfigParameter<std::string>("type");
 
    if (bool const component_id_required =
            !(type == "NormalTraction" || type == "ReleaseNodalForce");
        component_id_required && !config.component_id.has_value())
    {
        OGS_FATAL(
            "Specifying the component id (<component>) for a boundary "
            "condition of type {} is mandatory.",
            type);
    }
 
    if (type == "Dirichlet")
    {
        auto const parameter_name = parseDirichletBCConfig(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> dirichlet_conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            dirichlet_conditions.push_back(
                ProcessLib::createDirichletBoundaryCondition(
                    parameter_name, bc_mesh, dof_table, variable_id,
                    *config.component_id, parameters));
        }
        return dirichlet_conditions;
    }
    if (type == "DirichletWithinTimeInterval")
    {
        auto const config_args =
            parseDirichletBoundaryConditionWithinTimeIntervalConfig(
                config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(
                ProcessLib::createDirichletBoundaryConditionWithinTimeInterval(
                    config_args, bc_mesh, dof_table, variable_id,
                    *config.component_id, parameters));
        }
        return conditions;
    }
    if (type == "TimeDecayDirichlet")
    {
        auto const config_args =
            parseTimeDecayDirichletBoundaryConditionConfig(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(
                ProcessLib::createTimeDecayDirichletBoundaryCondition(
                    config_args, variable_id, *config.component_id, bc_mesh,
                    dof_table, parameters));
        }
        return conditions;
    }
    if (type == "Neumann")
    {
        auto const config_args = parseNeumannBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(ProcessLib::createNeumannBoundaryCondition(
                config_args, bc_mesh, dof_table, variable_id,
                *config.component_id, integration_order, shapefunction_order,
                bulk_mesh.getDimension(), parameters));
        }
        return conditions;
    }
    if (type == "Robin")
    {
        auto const config_args = parseRobinBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(ProcessLib::createRobinBoundaryCondition(
                config_args, bc_mesh, dof_table, variable_id,
                *config.component_id, integration_order, shapefunction_order,
                bulk_mesh.getDimension(), parameters));
        }
        return conditions;
    }
    if (type == "VariableDependentNeumann")
    {
        auto const config_args =
            parseVariableDependentNeumannBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(
                ProcessLib::createVariableDependentNeumannBoundaryCondition(
                    config_args, bc_mesh, dof_table, variable_id,
                    *config.component_id, integration_order,
                    shapefunction_order, bulk_mesh.getDimension(), parameters));
        }
        return conditions;
    }
    if (type == "Python")
    {
        auto const config_args = parsePythonBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(ProcessLib::createPythonBoundaryCondition(
                config_args, bc_mesh, dof_table, bulk_mesh, variable_id,
                *config.component_id, integration_order, shapefunction_order,
                all_process_variables_for_this_process));
        }
        return conditions;
    }
 
    //
    // Special boundary conditions
    //
    if (type == "ConstraintDirichlet")
    {
        auto const config_args =
            parseConstraintDirichletBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(
                ProcessLib::createConstraintDirichletBoundaryCondition(
                    config_args, bc_mesh, dof_table, variable_id,
                    integration_order, *config.component_id, parameters,
                    process));
        }
        return conditions;
    }
    if (type == "PrimaryVariableConstraintDirichlet")
    {
        auto const config_args =
            parsePrimaryVariableConstraintDirichletBoundaryCondition(
                config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(
                createPrimaryVariableConstraintDirichletBoundaryCondition(
                    config_args, bc_mesh, dof_table, variable_id,
                    *config.component_id, parameters));
        }
        return conditions;
    }
    if (type == "WellboreCompensateNeumann")
    {
        auto const config_args =
            parseWellboreCompensateNeumannBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(
                ProcessLib::createWellboreCompensateNeumannBoundaryCondition(
                    config_args, bc_mesh, dof_table, variable_id,
                    *config.component_id, integration_order,
                    shapefunction_order, bulk_mesh.getDimension(), media));
        }
        return conditions;
    }
    if (type == "SolutionDependentDirichlet")
    {
        auto const config_args =
            parseSolutionDependentDirichletBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(
                ProcessLib::createSolutionDependentDirichletBoundaryCondition(
                    config_args, bc_mesh, dof_table, variable_id,
                    *config.component_id, parameters));
        }
        return conditions;
    }
    if (type == "HCNonAdvectiveFreeComponentFlowBoundary")
    {
        auto const boundary_permeability_name =
            parseHCNonAdvectiveFreeComponentFlowBoundaryCondition(
                config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(
                createHCNonAdvectiveFreeComponentFlowBoundaryCondition(
                    boundary_permeability_name, bc_mesh, dof_table, variable_id,
                    *config.component_id, integration_order, parameters,
                    bulk_mesh.getDimension(), process, shapefunction_order));
        }
        return conditions;
    }
    if (type == "NormalTraction")
    {
        auto const parameter_name = NormalTractionBoundaryCondition::
            parseNormalTractionBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            switch (bulk_mesh.getDimension())
            {
                case 2:
                    conditions.push_back(
                        ProcessLib::NormalTractionBoundaryCondition::
                            createNormalTractionBoundaryCondition<2>(
                                parameter_name, bc_mesh, bulk_mesh, dof_table,
                                variable_id, integration_order,
                                shapefunction_order, parameters));
                    break;
                case 3:
                    conditions.push_back(
                        ProcessLib::NormalTractionBoundaryCondition::
                            createNormalTractionBoundaryCondition<3>(
                                parameter_name, bc_mesh, bulk_mesh, dof_table,
                                variable_id, integration_order,
                                shapefunction_order, parameters));
                    break;
                default:
                    OGS_FATAL(
                        "NormalTractionBoundaryCondition can not be "
                        "instantiated for mesh dimensions other than two or "
                        "three. {}-dimensional mesh was given.",
                        bulk_mesh.getDimension());
            }
        }
        return conditions;
    }
    if (type == "PhaseFieldIrreversibleDamageOracleBoundaryCondition")
    {
        parsePhaseFieldIrreversibleDamageOracleBoundaryCondition(config.config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        conditions.push_back(
            createPhaseFieldIrreversibleDamageOracleBoundaryCondition(
                dof_table, bulk_mesh, variable_id, *config.component_id));
        return conditions;
    }
    if (type == "ReleaseNodalForce")
    {
        auto const decay_parameter_name = parseReleaseNodalForce(config);
        std::vector<std::unique_ptr<BoundaryCondition>> conditions;
        for (auto const& bc_mesh : config.boundary_meshes)
        {
            conditions.push_back(ProcessLib::createReleaseNodalForce(
                bulk_mesh.getDimension(), variable_id, decay_parameter_name,
                config, bc_mesh, dof_table, parameters));
        }
        return conditions;
    }
    OGS_FATAL("Unknown boundary condition type: `{:s}'.", type);
}

References ProcessLib::BoundaryConditionConfig::boundary_meshes, ProcessLib::BoundaryConditionConfig::component_id, ProcessLib::BoundaryConditionConfig::config, createConstraintDirichletBoundaryCondition(), createDirichletBoundaryCondition(), createDirichletBoundaryConditionWithinTimeInterval(), createHCNonAdvectiveFreeComponentFlowBoundaryCondition(), createNeumannBoundaryCondition(), createPhaseFieldIrreversibleDamageOracleBoundaryCondition(), createPrimaryVariableConstraintDirichletBoundaryCondition(), createPythonBoundaryCondition(), createReleaseNodalForce(), createRobinBoundaryCondition(), createSolutionDependentDirichletBoundaryCondition(), createTimeDecayDirichletBoundaryCondition(), createVariableDependentNeumannBoundaryCondition(), createWellboreCompensateNeumannBoundaryCondition(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::isAxiallySymmetric(), OGS_FATAL, parseConstraintDirichletBoundaryCondition(), parseDirichletBCConfig(), parseDirichletBoundaryConditionWithinTimeIntervalConfig(), parseHCNonAdvectiveFreeComponentFlowBoundaryCondition(), parseNeumannBoundaryCondition(), ProcessLib::NormalTractionBoundaryCondition::parseNormalTractionBoundaryCondition(), parsePhaseFieldIrreversibleDamageOracleBoundaryCondition(), parsePrimaryVariableConstraintDirichletBoundaryCondition(), parsePythonBoundaryCondition(), parseReleaseNodalForce(), parseRobinBoundaryCondition(), parseSolutionDependentDirichletBoundaryCondition(), parseTimeDecayDirichletBoundaryConditionConfig(), parseVariableDependentNeumannBoundaryCondition(), parseWellboreCompensateNeumannBoundaryCondition(), and BaseLib::ConfigTree::peekConfigParameter().

Referenced by ProcessLib::ProcessVariable::createBoundaryConditions().

createBoundaryDOFTable()

std::unique_ptr< NumLib::LocalToGlobalIndexMap > ProcessLib::createBoundaryDOFTable	(	int const	variable_id,
		int const	component_id,
		MeshLib::Mesh const &	boundary_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk )

Definition at line 16 of file TimeDecayDirichletBoundaryCondition.cpp.

{
    checkParametersOfDirichletBoundaryCondition(boundary_mesh, dof_table_bulk,
                                                variable_id, component_id);
 
    std::vector<MeshLib::Node*> const& bc_nodes = boundary_mesh.getNodes();
    MeshLib::MeshSubset bc_mesh_subset(boundary_mesh, bc_nodes);
 
    // Create local DOF table from the BC mesh subset for the given variable
    // and component id.
    return dof_table_bulk.deriveBoundaryConstrainedMap(
        variable_id, {component_id}, std::move(bc_mesh_subset));
}

References checkParametersOfDirichletBoundaryCondition(), NumLib::LocalToGlobalIndexMap::deriveBoundaryConstrainedMap(), and MeshLib::Mesh::getNodes().

Referenced by ProcessLib::TimeDecayDirichletBoundaryCondition::TimeDecayDirichletBoundaryCondition().

createCentralDifferencesJacobianAssembler()

std::unique_ptr< AbstractJacobianAssembler > ProcessLib::createCentralDifferencesJacobianAssembler

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__processes__process__jacobian_assembler__type

Input File Parameter

special OGS input file parameter

Input File Parameter

prj__processes__process__jacobian_assembler__CentralDifferences__epsilons

Definition at line 14 of file CreateCentralDifferencesJacobianAssembler.cpp.

{
    config.checkConfigParameter("type", "CentralDifferences");
 
    // TODO: to be removed
    {
        std::vector<std::string> const deprecated_keys{"relative_epsilons",
                                                       "component_magnitudes"};
        for (auto const& key : deprecated_keys)
        {
            auto const deprecated_parameter =
                config.getConfigParameterOptional<std::vector<double>>(key);
            if ((deprecated_parameter.has_value() &&
                 !deprecated_parameter->empty()))
            {
                OGS_FATAL(
                    "Configuration parameter <{:s}> is deprecated and no "
                    "longer "
                    "supported.\n"
                    "(Removed in OGS version 6.5.6)\n\n"
                    "The numerical Jacobian assembler now uses absolute "
                    "perturbation values instead of relative scaling.\n\n"
                    "Migration required:\n"
                    "  Old approach:\n"
                    "    <relative_epsilons>1e-6 1e-6</relative_epsilons>\n"
                    "    <component_magnitudes>1e2 1e2</component_magnitudes>\n"
                    "  New approach:\n"
                    "    <epsilons>1e-4 1e-4</epsilons>\n"
                    " where the epsilons are equal component-wise to "
                    "relative_epsilons * component_magnitudes",
                    key);
            }
        }
    }

    auto epsilons = config.getConfigParameter<std::vector<double>>("epsilons");
 
    return std::make_unique<CentralDifferencesJacobianAssembler>(
        std::move(epsilons));
}

References BaseLib::ConfigTree::checkConfigParameter(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigParameterOptional(), and OGS_FATAL.

Referenced by createJacobianAssembler().

createCompareJacobiansJacobianAssembler()

std::unique_ptr< CompareJacobiansJacobianAssembler > ProcessLib::createCompareJacobiansJacobianAssembler

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__processes__process__jacobian_assembler__type

Input File Parameter

prj__processes__process__jacobian_assembler__CompareJacobians__jacobian_assembler

Input File Parameter

prj__processes__process__jacobian_assembler__CompareJacobians__reference_jacobian_assembler

Input File Parameter

prj__processes__process__jacobian_assembler__CompareJacobians__abs_tol

Input File Parameter

prj__processes__process__jacobian_assembler__CompareJacobians__rel_tol

Input File Parameter

prj__processes__process__jacobian_assembler__CompareJacobians__fail_on_error

Input File Parameter

prj__processes__process__jacobian_assembler__CompareJacobians__log_file

Definition at line 350 of file CompareJacobiansJacobianAssembler.cpp.

{
    // TODO doc script corner case: Parameter could occur at different
    // locations.
    config.checkConfigParameter("type", "CompareJacobians");
 
    auto asm1 =
        createJacobianAssembler(config.getConfigSubtree("jacobian_assembler"));
 
    auto asm2 = createJacobianAssembler(
        config.getConfigSubtree("reference_jacobian_assembler"));

    auto const abs_tol = config.getConfigParameter<double>("abs_tol");
    auto const rel_tol = config.getConfigParameter<double>("rel_tol");

    auto const fail_on_error = config.getConfigParameter<bool>("fail_on_error");

    auto const log_file = config.getConfigParameter<std::string>("log_file");
 
    return std::make_unique<CompareJacobiansJacobianAssembler>(
        std::move(asm1), std::move(asm2), abs_tol, rel_tol, fail_on_error,
        log_file);
}

References BaseLib::ConfigTree::checkConfigParameter(), createJacobianAssembler(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::getConfigSubtree().

Referenced by createJacobianAssembler().

createConstraintDirichletBoundaryCondition()

std::unique_ptr< ConstraintDirichletBoundaryCondition > ProcessLib::createConstraintDirichletBoundaryCondition	(	ConstraintDirichletBoundaryConditionConfig const &	config,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		int const	variable_id,
		unsigned const	integration_order,
		int const	component_id,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		Process const &	constraining_process )

The function parses the config tree and creates a ConstraintDirichletBoundaryCondition.

Definition at line 249 of file ConstraintDirichletBoundaryCondition.cpp.

{
    DBUG("Constructing ConstraintDirichletBoundaryCondition");
 
    if (config.constraint_type != "Flux")
    {
        OGS_FATAL("The constraint type is '{:s}', but has to be 'Flux'.",
                  config.constraint_type);
    }
 
    if (!constraining_process.isMonolithicSchemeUsed())
    {
        OGS_FATAL(
            "The constraint dirichlet boundary condition is implemented only "
            "for monolithic implemented processes.");
    }
    const int process_id = 0;
    auto process_variables =
        constraining_process.getProcessVariables(process_id);
    auto constraining_pv = std::find_if(
        process_variables.cbegin(), process_variables.cend(),
        [&config](ProcessVariable const& pv)
        { return pv.getName() == config.constraining_process_variable; });
    if (constraining_pv == std::end(process_variables))
    {
        auto const& constraining_process_variable_name =
            process_variables[variable_id].get().getName();
        OGS_FATAL(
            "<constraining_process_variable> in process variable name '{:s}' "
            "at geometry 'TODO' : The constraining process variable is set as "
            "'{:s}', but this is not specified in the project file.",
            constraining_process_variable_name,
            config.constraining_process_variable);
    }
 
    if (config.constraint_direction != "greater" &&
        config.constraint_direction != "lower")
    {
        OGS_FATAL(
            "The constraint direction is '{:s}', but has to be either "
            "'greater' or 'lower'.",
            config.constraint_direction);
    }
    bool const lower = config.constraint_direction == "lower";
 
    auto& param = ParameterLib::findParameter<double>(config.parameter_name,
                                                      parameters, 1, &bc_mesh);
 
    // In case of partitioned mesh the boundary could be empty, i.e. there is no
    // boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<ConstraintDirichletBoundaryCondition>(
        param, dof_table_bulk, variable_id, component_id, bc_mesh,
        integration_order, constraining_process.getMesh(),
        config.constraint_threshold, lower,
        [&constraining_process](std::size_t const element_id,
                                MathLib::Point3d const& pnt, double const t,
                                std::vector<GlobalVector*> const& x)
        { return constraining_process.getFlux(element_id, pnt, t, x); });
}

References ProcessLib::ConstraintDirichletBoundaryConditionConfig::constraining_process_variable, ProcessLib::ConstraintDirichletBoundaryConditionConfig::constraint_direction, ProcessLib::ConstraintDirichletBoundaryConditionConfig::constraint_threshold, ProcessLib::ConstraintDirichletBoundaryConditionConfig::constraint_type, createConstraintDirichletBoundaryCondition(), DBUG(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), ProcessLib::Process::getMesh(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), ProcessLib::Process::getProcessVariables(), ProcessLib::Process::isMonolithicSchemeUsed(), OGS_FATAL, and ProcessLib::ConstraintDirichletBoundaryConditionConfig::parameter_name.

Referenced by createBoundaryCondition(), and createConstraintDirichletBoundaryCondition().

createDeactivatedSubdomain()

DeactivatedSubdomain ProcessLib::createDeactivatedSubdomain	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	mesh,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__time_interval

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__time_curve

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__line_segment

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__ball

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__boundary_parameter

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__material_ids

Definition at line 231 of file CreateDeactivatedSubdomain.cpp.

{
    auto const& time_interval_config =
        config.getConfigSubtreeOptional("time_interval");
 
    auto const& curve_name =
        config.getConfigParameterOptional<std::string>("time_curve");
    auto time_interval =
        parseTimeIntervalOrCurve(time_interval_config, curve_name, curves);
 
    auto const line_segment_config =
        config.getConfigSubtreeOptional("line_segment");
 
    auto const ball_config =
        config.getConfigSubtreeOptional("ball");
 
    if (line_segment_config && ball_config)
    {
        OGS_FATAL(
            "line_segment and ball can not be defined "
            "simultaneously.");
    }
 
    if (time_interval_config && (line_segment_config || ball_config))
    {
        OGS_FATAL(
            "When using time interval for subdomain deactivation a line "
            "segment or a ball must not be specified.");
    }
 
    if (curve_name && !(line_segment_config || ball_config))
    {
        OGS_FATAL(
            "When using curve for subdomain deactivation a line segment or a "
            "ball must be specified.");
    }
 
    // If time interval was specified then an empty optional line segment is
    // used *internally* because the whole selected material ids subdomain will
    // be deactivated.
    std::optional<std::pair<Eigen::Vector3d, Eigen::Vector3d>> line_segment;
    if (line_segment_config)
    {
        line_segment = parseLineSegment(*line_segment_config);
    }
 
    std::optional<detail::Ball> ball;
    if (ball_config)
    {
        ball = parseBall(*ball_config);
    }
 
    ParameterLib::Parameter<double>* boundary_value_parameter = nullptr;
    auto boundary_value_parameter_name =
        config.getConfigParameterOptional<std::string>("boundary_parameter");
    if (boundary_value_parameter_name)
    {
        DBUG("Using parameter {:s}", *boundary_value_parameter_name);
        boundary_value_parameter = &ParameterLib::findParameter<double>(
            *boundary_value_parameter_name, parameters, 1, &mesh);
    }
 
    auto deactivated_subdomain_material_ids =
        config.getConfigParameter("material_ids", std::vector<int>{}) |
        ranges::to<std::unordered_set>();
 
    if (deactivated_subdomain_material_ids.empty())
    {
        OGS_FATAL(
            "The material IDs of the deactivated subdomains are not given. The "
            "program terminates now.");
    }
 
    if (materialIDs(mesh) == nullptr)
    {
        OGS_FATAL(
            "The mesh doesn't contain materialIDs for subdomain deactivation. "
            "The program terminates now.");
    }
 
    auto deactivated_subdomain_mesh = createDeactivatedSubdomainMesh(
        mesh, deactivated_subdomain_material_ids);
 
    return {std::move(time_interval), line_segment, ball,
            std::move(deactivated_subdomain_mesh), boundary_value_parameter};
}

References createDeactivatedSubdomainMesh(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigParameterOptional(), BaseLib::ConfigTree::getConfigSubtreeOptional(), OGS_FATAL, parseBall(), parseLineSegment(), and parseTimeIntervalOrCurve().

Referenced by createDeactivatedSubdomains().

createDeactivatedSubdomainMesh()

DeactivatedSubdomainMesh ProcessLib::createDeactivatedSubdomainMesh ( MeshLib::Mesh const & mesh, std::unordered_set< int > const & deactivated_subdomain_material_ids )

static

Definition at line 87 of file CreateDeactivatedSubdomain.cpp.

{
    // An element is active if its material id matches one of the deactivated
    // subdomain material ids.
    auto is_active =
        [&deactivated_subdomain_material_ids,
         &material_ids = *materialIDs(mesh)](std::size_t element_id)
    {
        return deactivated_subdomain_material_ids.contains(
            material_ids[element_id]);
    };
 
    auto const& elements = mesh.getElements();
    std::vector<MeshLib::Element*> deactivated_elements;
    ranges::copy_if(elements, back_inserter(deactivated_elements), is_active,
                    [](auto const e) { return e->getID(); });
 
    auto bulk_element_ids = deactivated_elements | MeshLib::views::ids |
                            ranges::to<std::unordered_set>;
 
    static int mesh_number = 0;
    // Subdomain mesh consisting of deactivated elements.
    auto sub_mesh = MeshLib::createMeshFromElementSelection(
        "deactivate_subdomain_" + std::to_string(mesh_number++),
        MeshLib::cloneElements(deactivated_elements));
 
    auto [inner_nodes, outer_nodes] =
        extractInnerAndOuterNodes(mesh, *sub_mesh, is_active);
 
    auto outer_nodes_elements =
        extractElementsAlongOuterNodes(mesh, *sub_mesh, outer_nodes);
 
    return {std::move(*sub_mesh), std::move(bulk_element_ids),
            std::move(inner_nodes), std::move(outer_nodes),
            std::move(outer_nodes_elements)};
}

References MeshLib::cloneElements(), MeshLib::createMeshFromElementSelection(), extractElementsAlongOuterNodes(), extractInnerAndOuterNodes(), MeshLib::Mesh::getElements(), and MeshLib::views::ids.

Referenced by createDeactivatedSubdomain().

createDeactivatedSubdomains()

std::vector< DeactivatedSubdomain > ProcessLib::createDeactivatedSubdomains	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	mesh,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const &	curves )

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain

Definition at line 329 of file CreateDeactivatedSubdomain.cpp.

{
    std::vector<DeactivatedSubdomain> deactivated_subdomains;
    // Deactivated subdomains
    if (auto subdomains_config =
        config.getConfigSubtreeOptional("deactivated_subdomains"))
    {
        INFO("There are subdomains being deactivated.");
 
        auto const deactivated_subdomain_configs =
            subdomains_config->getConfigSubtreeList("deactivated_subdomain");
        std::transform(std::begin(deactivated_subdomain_configs),
                       std::end(deactivated_subdomain_configs),
                       std::back_inserter(deactivated_subdomains),
                       [&](auto const& config) {
                           return createDeactivatedSubdomain(
                               config, mesh, parameters, curves);
                       });
    }
    return deactivated_subdomains;
}

References createDeactivatedSubdomain(), BaseLib::ConfigTree::getConfigSubtreeOptional(), and INFO().

Referenced by ProcessLib::ProcessVariable::ProcessVariable().

createDirichletBoundaryCondition()

std::unique_ptr< DirichletBoundaryCondition > ProcessLib::createDirichletBoundaryCondition	(	std::string const &	parameter_name,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		int const	variable_id,
		int const	component_id,
		const std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &	parameters )

Definition at line 60 of file DirichletBoundaryCondition.cpp.

{
    DBUG("Constructing DirichletBoundaryCondition.");
 
    auto& parameter = ParameterLib::findParameter<double>(
        parameter_name, parameters, 1, &bc_mesh);
 
// In case of partitioned mesh the boundary could be empty, i.e. there is no
// boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<DirichletBoundaryCondition>(
        parameter, bc_mesh, dof_table_bulk, variable_id, component_id);
}

References DBUG(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getNumberOfElements(), and MeshLib::Mesh::getNumberOfNodes().

Referenced by createBoundaryCondition().

createDirichletBoundaryConditionWithinTimeInterval()

std::unique_ptr< BoundaryCondition > ProcessLib::createDirichletBoundaryConditionWithinTimeInterval	(	DirichletBoundaryConditionConfig const &	config_args,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		int const	variable_id,
		int const	component_id,
		const std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &	parameters )

Definition at line 33 of file CreateDirichletBoundaryConditionWithinTimeInterval.cpp.

{
    DBUG("Constructing DirichletBoundaryConditionWithinTimeInterval.");
 
    auto& param = ParameterLib::findParameter<double>(
        config_args.parameter_name, parameters, 1, &bc_mesh);
 
// In case of partitioned mesh the boundary could be empty, i.e. there is no
// boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<DirichletBoundaryConditionWithinTimeInterval>(
        std::move(config_args.time_interval), param, bc_mesh, dof_table_bulk,
        variable_id, component_id);
}

References DBUG(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), ProcessLib::DirichletBoundaryConditionConfig::parameter_name, and ProcessLib::DirichletBoundaryConditionConfig::time_interval.

Referenced by createBoundaryCondition().

createEmbeddedAnchor()

template<int GlobalDim>

std::unique_ptr< SourceTermBase > ProcessLib::createEmbeddedAnchor	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	st_mesh,
		MeshLib::Mesh const &	bulk_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		std::size_t const	source_term_mesh_id,
		const int	variable_id )

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__EmbeddedAnchor

Input File Parameter

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__type

Definition at line 14 of file CreateEmbeddedAnchor.cpp.

{
    DBUG("Constructing EmbeddedAnchor from config.");
    // ...special is necessary, because EmbeddedAnchor has no configuration via
    // child tags, hence it wouldn't be handled properly by the documentation
    // scripts otherwise.
    config.checkConfigParameter("type", "EmbeddedAnchor");
 
    for (MeshLib::Element const* const element : st_mesh.getElements())
    {
        if (element->getNumberOfNodes() != 2)
        {
            OGS_FATAL(
                "Every anchor element needs to have precisely two nodes.");
        }
    }
#ifdef USE_PETSC
    OGS_FATAL(
        "The EmbeddedAnchor source term has not been tested with PETSc yet.");
#endif
 
    return std::make_unique<EmbeddedAnchor<GlobalDim>>(
        bulk_mesh, dof_table_bulk, source_term_mesh_id, st_mesh, variable_id);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), MeshLib::Mesh::getElements(), and OGS_FATAL.

createEmbeddedAnchor< 2 >()

template std::unique_ptr< SourceTermBase > ProcessLib::createEmbeddedAnchor< 2 >	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	st_mesh,
		MeshLib::Mesh const &	bulk_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		std::size_t const	source_term_mesh_id,
		const int	variable_id )

Referenced by createSourceTerm().

createEmbeddedAnchor< 3 >()

template std::unique_ptr< SourceTermBase > ProcessLib::createEmbeddedAnchor< 3 >	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	st_mesh,
		MeshLib::Mesh const &	bulk_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		std::size_t const	source_term_mesh_id,
		const int	variable_id )

Referenced by createSourceTerm().

createForwardDifferencesJacobianAssembler()

std::unique_ptr< AbstractJacobianAssembler > ProcessLib::createForwardDifferencesJacobianAssembler

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__processes__process__jacobian_assembler__type

Input File Parameter

special OGS input file parameter

Input File Parameter

prj__processes__process__jacobian_assembler__ForwardDifferences__epsilons

Definition at line 13 of file CreateForwardDifferencesJacobianAssembler.cpp.

{
    config.checkConfigParameter("type", "ForwardDifferences");
 
    // TODO: to be removed
    {
        std::vector<std::string> const deprecated_keys{"relative_epsilons",
                                                       "component_magnitudes"};
        for (auto const& key : deprecated_keys)
        {
            auto const deprecated_parameter =
                config.getConfigParameterOptional<std::vector<double>>(key);
 
            if ((deprecated_parameter.has_value() &&
                 !deprecated_parameter->empty()))
            {
                OGS_FATAL(
                    "Configuration parameter <{:s}> is deprecated and no "
                    "longer supported.\n"
                    "(Removed in OGS version 6.5.6)\n\n"
                    "The numerical Jacobian assembler now uses absolute "
                    "perturbation values instead of relative scaling.\n\n"
                    "Migration required:\n"
                    "  Old approach:\n"
                    "    <relative_epsilons>1e-6 1e-6</relative_epsilons>\n"
                    "    <component_magnitudes>1e2 1e2</component_magnitudes>\n"
                    "  New approach:\n"
                    "    <epsilons>1e-4 1e-4</epsilons>\n"
                    " where the epsilons are equal component-wise to "
                    "relative_epsilons * component_magnitudes",
                    key);
            }
        }
    }

    auto epsilons = config.getConfigParameter<std::vector<double>>("epsilons");
 
    return std::make_unique<ForwardDifferencesJacobianAssembler>(
        std::move(epsilons));
}

References BaseLib::ConfigTree::checkConfigParameter(), BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigParameterOptional(), and OGS_FATAL.

Referenced by createJacobianAssembler().

createHCNonAdvectiveFreeComponentFlowBoundaryCondition()

std::unique_ptr< HCNonAdvectiveFreeComponentFlowBoundaryCondition > ProcessLib::createHCNonAdvectiveFreeComponentFlowBoundaryCondition	(	std::string const &	boundary_permeability_name,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		int const	variable_id,
		int const	component_id,
		unsigned const	integration_order,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		unsigned const	global_dim,
		Process const &	process,
		unsigned const	shapefunction_order )

Definition at line 28 of file HCNonAdvectiveFreeComponentFlowBoundaryCondition.cpp.

{
    DBUG("Constructing open boundary for Component Transport process.");
 
    if (bc_mesh.getDimension() + 1 != global_dim)
    {
        OGS_FATAL(
            "The dimension ({:d}) of the given boundary mesh '{:s}' is not by "
            "one lower than the bulk dimension ({:d}).",
            bc_mesh.getDimension(), bc_mesh.getName(), global_dim);
    }
 
    auto const& boundary_permeability = ParameterLib::findParameter<double>(
        boundary_permeability_name, parameters, 1, &bc_mesh);
 
    if (global_dim != 3)
    {
        OGS_FATAL(
            "HCNonAdvectiveFreeComponentFlowBoundary is only implemented for "
            "2D boundary meshes");
    }
    auto const bulk_element_ids =
        bc_mesh.getProperties().template getPropertyVector<std::size_t>(
            MeshLib::getBulkIDString(MeshLib::MeshItemType::Cell),
            MeshLib::MeshItemType::Cell, 1);
    auto const bulk_face_ids =
        bc_mesh.getProperties().template getPropertyVector<std::size_t>(
            MeshLib::getBulkIDString(MeshLib::MeshItemType::Face),
            MeshLib::MeshItemType::Cell, 1);
 
    // In case of partitioned mesh the boundary could be empty, i.e. there is no
    // boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<HCNonAdvectiveFreeComponentFlowBoundaryCondition>(
        integration_order, shapefunction_order, dof_table, variable_id,
        component_id, global_dim, bc_mesh,
        HCNonAdvectiveFreeComponentFlowBoundaryConditionData{
            boundary_permeability, *bulk_face_ids, *bulk_element_ids, process});
}

References MeshLib::Cell, DBUG(), MeshLib::Face, ParameterLib::findParameter(), MeshLib::getBulkIDString(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getName(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), MeshLib::Mesh::getProperties(), and OGS_FATAL.

Referenced by createBoundaryCondition().

createInitialStress()

template<int DisplacementDim>

InitialStress ProcessLib::createInitialStress	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		MeshLib::Mesh const &	mesh,
		bool const	mandatory_stress_type )

Input File Parameter

prj__processes__process__initial_stress

Input File Parameter

prj__processes__process__initial_stress__type

Definition at line 17 of file CreateInitialStress.cpp.

{
    auto const config_stress0 =
        config.getConfigSubtreeOptional("initial_stress");
 
    if (!config_stress0)
    {
        return {};
    }
 
    auto const stress0_type_opt =
        config_stress0->getConfigAttributeOptional<std::string>("type");
 
    // If the type is mandatory required but it is not presented:
    if (mandatory_stress_type && !stress0_type_opt)
    {
        OGS_FATAL(
            "The attribute \"type\" of the tag \"initial_stress\" is required "
            "for the current process setting, for example using subtype = "
            "\"StressSaturation_StrainPressureTemperature\" in TRM. "
            "However it is missing.");
    }
 
    auto const stress0_type_str =
        stress0_type_opt ? *stress0_type_opt : "effective";
 
    InitialStress::Type stress0_type;
    if (stress0_type_str == "total")
    {
        stress0_type = InitialStress::Type::Total;
    }
    else if (stress0_type_str == "effective")
    {
        stress0_type = InitialStress::Type::Effective;
    }
    else
    {
        OGS_FATAL(
            "The initial stress type must be \"total\" or "
            "\"effective\". But the given one is {:s}",
            stress0_type_str);
    }
 
    auto const parameter_name = config_stress0->getValue<std::string>();
    auto const initial_stress = &ParameterLib::findParameter<double>(
        parameter_name, parameters,
        MathLib::KelvinVector::kelvin_vector_dimensions(DisplacementDim),
        &mesh);
 
    return {initial_stress, stress0_type};
}

References ProcessLib::InitialStress::Effective, ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigSubtreeOptional(), MathLib::KelvinVector::kelvin_vector_dimensions(), OGS_FATAL, and ProcessLib::InitialStress::Total.

Referenced by ProcessLib::HydroMechanics::createHydroMechanicsProcess(), ProcessLib::PhaseField::createPhaseFieldProcess(), ProcessLib::RichardsMechanics::createRichardsMechanicsProcess(), ProcessLib::TH2M::createTH2MProcess(), ProcessLib::ThermoHydroMechanics::createThermoHydroMechanicsProcess(), and ProcessLib::ThermoRichardsMechanics::createThermoRichardsMechanicsProcessStage2().

createInitialStress< 2 >()

template InitialStress ProcessLib::createInitialStress< 2 >	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		MeshLib::Mesh const &	mesh,
		bool const	mandatory_stress_type )

createInitialStress< 3 >()

template InitialStress ProcessLib::createInitialStress< 3 >	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		MeshLib::Mesh const &	mesh,
		bool const	mandatory_stress_type )

createJacobianAssembler()

std::unique_ptr< AbstractJacobianAssembler > ProcessLib::createJacobianAssembler

(

std::optional< BaseLib::ConfigTree > const &

config

)

Input File Parameter

prj__processes__process__jacobian_assembler__type

Definition at line 15 of file CreateJacobianAssembler.cpp.

{
    if (!config)
    {
        return std::make_unique<AnalyticalJacobianAssembler>();
    }

    auto const type = config->peekConfigParameter<std::string>("type");
 
    if (type == "Analytical")
    {
        config->ignoreConfigParameter("type");
        return std::make_unique<AnalyticalJacobianAssembler>();
    }
    if (type == "CentralDifferences")
    {
        return createCentralDifferencesJacobianAssembler(*config);
    }
    if (type == "CompareJacobians")
    {
        return createCompareJacobiansJacobianAssembler(*config);
    }
    if (type == "ForwardDifferences")
    {
        return createForwardDifferencesJacobianAssembler(*config);
    }
 
    OGS_FATAL("Unknown Jacobian assembler type: `{:s}'.", type);
}

References createCentralDifferencesJacobianAssembler(), createCompareJacobiansJacobianAssembler(), createForwardDifferencesJacobianAssembler(), and OGS_FATAL.

Referenced by createCompareJacobiansJacobianAssembler(), and ProjectData::parseProcesses().

createLocalAssemblers() [1/2]

template<template< typename, int > class LocalAssemblerImplementation, typename LocalAssemblerInterface, IntegrationMethodProviderOrIntegrationOrder ProviderOrOrder, typename... ExtraCtorArgs>

void ProcessLib::createLocalAssemblers	(	const unsigned	dimension,
		std::vector< MeshLib::Element * > const &	mesh_elements,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		std::vector< std::unique_ptr< LocalAssemblerInterface > > &	local_assemblers,
		ProviderOrOrder const &	provider_or_order,
		ExtraCtorArgs &&...	extra_ctor_args )

Creates local assemblers for each element of the given mesh.

Template Parameters

LocalAssemblerImplementation	the individual local assembler type
LocalAssemblerInterface	the general local assembler interface
ExtraCtorArgs	types of additional constructor arguments. Those arguments will be passed to the constructor of LocalAssemblerImplementation.

The first two template parameters cannot be deduced from the arguments. Therefore they always have to be provided manually.

Definition at line 68 of file Utils/CreateLocalAssemblers.h.

{
    DBUG("Create local assemblers.");
 
    switch (dimension)
    {
        case 1:
            createLocalAssemblers<1, LocalAssemblerImplementation>(
                mesh_elements, dof_table, local_assemblers, provider_or_order,
                std::forward<ExtraCtorArgs>(extra_ctor_args)...);
            break;
        case 2:
            createLocalAssemblers<2, LocalAssemblerImplementation>(
                mesh_elements, dof_table, local_assemblers, provider_or_order,
                std::forward<ExtraCtorArgs>(extra_ctor_args)...);
            break;
        case 3:
            createLocalAssemblers<3, LocalAssemblerImplementation>(
                mesh_elements, dof_table, local_assemblers, provider_or_order,
                std::forward<ExtraCtorArgs>(extra_ctor_args)...);
            break;
        default:
            OGS_FATAL(
                "Meshes with dimension greater than three are not supported.");
    }
}

References createLocalAssemblers(), DBUG(), and OGS_FATAL.

createLocalAssemblers() [2/2]

template<int GlobalDim, template< typename, int > class LocalAssemblerImplementation, typename LocalAssemblerInterface, IntegrationMethodProviderOrIntegrationOrder ProviderOrOrder, typename... ExtraCtorArgs>

void ProcessLib::createLocalAssemblers	(	std::vector< MeshLib::Element * > const &	mesh_elements,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		std::vector< std::unique_ptr< LocalAssemblerInterface > > &	local_assemblers,
		ProviderOrOrder const &	provider_or_order,
		ExtraCtorArgs &&...	extra_ctor_args )

Definition at line 21 of file Utils/CreateLocalAssemblers.h.

{
    static_assert(
        GlobalDim == 1 || GlobalDim == 2 || GlobalDim == 3,
        "Meshes with dimension greater than three are not supported.");
 
    DBUG("Create local assemblers.");
 
    auto const& integration_method_provider =
        getIntegrationMethodProvider(provider_or_order);
 
    using IntegrationMethodProvider =
        std::remove_cvref_t<decltype(integration_method_provider)>;
    using LocAsmFac = LocalAssemblerFactory<
        LocalAssemblerInterface, LocalAssemblerImplementation,
        IntegrationMethodProvider, GlobalDim, ExtraCtorArgs...>;
 
    LocAsmFac factory(dof_table, integration_method_provider);
    local_assemblers.resize(mesh_elements.size());
 
    DBUG("Calling local assembler builder for all mesh elements.");
    GlobalExecutor::transformDereferenced(
        factory, mesh_elements, local_assemblers,
        std::forward<ExtraCtorArgs>(extra_ctor_args)...);
}

References createLocalAssemblers(), DBUG(), and NumLib::SerialExecutor::transformDereferenced().

Referenced by ProcessLib::SurfaceFlux::SurfaceFlux(), createLocalAssemblers(), createLocalAssemblers(), ProcessLib::ComponentTransport::ComponentTransportProcess::initializeConcreteProcess(), ProcessLib::HeatConduction::HeatConductionProcess::initializeConcreteProcess(), ProcessLib::HT::HTProcess::initializeConcreteProcess(), ProcessLib::LiquidFlow::LiquidFlowProcess::initializeConcreteProcess(), ProcessLib::RichardsComponentTransport::RichardsComponentTransportProcess::initializeConcreteProcess(), ProcessLib::RichardsFlow::RichardsFlowProcess::initializeConcreteProcess(), ProcessLib::SteadyStateDiffusion::SteadyStateDiffusion::initializeConcreteProcess(), ProcessLib::ThermalTwoPhaseFlowWithPP::ThermalTwoPhaseFlowWithPPProcess::initializeConcreteProcess(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowProcess::initializeConcreteProcess(), ProcessLib::TwoPhaseFlowWithPP::TwoPhaseFlowWithPPProcess::initializeConcreteProcess(), and ProcessLib::WellboreSimulator::WellboreSimulatorProcess::initializeConcreteProcess().

createLocalAssemblersHM()

template<int GlobalDim, template< typename, typename, int > class LocalAssemblerImplementation, typename LocalAssemblerInterface, IntegrationMethodProviderOrIntegrationOrder ProviderOrOrder, typename... ExtraCtorArgs>

void ProcessLib::createLocalAssemblersHM	(	std::vector< MeshLib::Element * > const &	mesh_elements,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		std::vector< std::unique_ptr< LocalAssemblerInterface > > &	local_assemblers,
		ProviderOrOrder const &	provider_or_order,
		ExtraCtorArgs &&...	extra_ctor_args )

Definition at line 78 of file CreateLocalAssemblersTaylorHood.h.

{
    detail::createLocalAssemblersTaylorHood<LocalAssemblerFactoryHM, GlobalDim,
                                            LocalAssemblerImplementation,
                                            LocalAssemblerInterface>(
        mesh_elements, dof_table, local_assemblers, provider_or_order,
        std::forward<ExtraCtorArgs>(extra_ctor_args)...);
}

References createLocalAssemblersHM(), and ProcessLib::detail::createLocalAssemblersTaylorHood().

Referenced by ProcessLib::TH2M::createLocalAssemblers(), ProcessLib::ThermoRichardsMechanics::createLocalAssemblers(), createLocalAssemblersHM(), ProcessLib::HydroMechanics::HydroMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::RichardsMechanics::RichardsMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), and ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsProcess< DisplacementDim >::initializeConcreteProcess().

createLocalAssemblersStokes()

template<int GlobalDim, template< typename, typename, int > class LocalAssemblerImplementation, typename LocalAssemblerInterface, IntegrationMethodProviderOrIntegrationOrder ProviderOrOrder, typename... ExtraCtorArgs>

void ProcessLib::createLocalAssemblersStokes	(	std::vector< MeshLib::Element * > const &	mesh_elements,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		std::vector< std::unique_ptr< LocalAssemblerInterface > > &	local_assemblers,
		ProviderOrOrder const &	provider_or_order,
		ExtraCtorArgs &&...	extra_ctor_args )

Definition at line 99 of file CreateLocalAssemblersTaylorHood.h.

{
    detail::createLocalAssemblersTaylorHood<
        LocalAssemblerFactoryStokes, GlobalDim, LocalAssemblerImplementation,
        LocalAssemblerInterface>(
        mesh_elements, dof_table, local_assemblers, provider_or_order,
        std::forward<ExtraCtorArgs>(extra_ctor_args)...);
}

References createLocalAssemblersStokes(), and ProcessLib::detail::createLocalAssemblersTaylorHood().

Referenced by createLocalAssemblersStokes().

createNeumannBoundaryCondition()

std::unique_ptr< NeumannBoundaryCondition > ProcessLib::createNeumannBoundaryCondition	(	NeumannBoundaryConditionConfig const &	config,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		int const	variable_id,
		int const	component_id,
		unsigned const	integration_order,
		unsigned const	shapefunction_order,
		unsigned const	global_dim,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Definition at line 32 of file NeumannBoundaryCondition.cpp.

{
    DBUG("Constructing Neumann BC.");
 
    auto const& param = ParameterLib::findParameter<double>(
        config.parameter_name, parameters, 1, &bc_mesh);
 
    // In case of partitioned mesh the boundary could be empty, i.e. there
    // is no boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    ParameterLib::Parameter<double> const* integral_measure(nullptr);
    if (global_dim - bc_mesh.getDimension() != 1)
    {
        if (!config.area_parameter_name)
        {
            OGS_FATAL("{}: tag <area_parameter> required in Neumann BC.",
                      __FUNCTION__);
        }
        integral_measure = &ParameterLib::findParameter<double>(
            config.area_parameter_name.value(), parameters, 1, &bc_mesh);
    }
 
    if (bc_mesh.getDimension() >= global_dim)
    {
        OGS_FATAL(
            "The dimension ({:d}) of the given boundary mesh '{:s}' is not "
            "lower than the bulk dimension ({:d}).",
            bc_mesh.getDimension(), bc_mesh.getName(), global_dim);
    }
 
    return std::make_unique<NeumannBoundaryCondition>(
        integration_order, shapefunction_order, dof_table, variable_id,
        component_id, global_dim, bc_mesh,
        NeumannBoundaryConditionData{param, integral_measure});
}

References ProcessLib::NeumannBoundaryConditionConfig::area_parameter_name, DBUG(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getName(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), OGS_FATAL, and ProcessLib::NeumannBoundaryConditionConfig::parameter_name.

Referenced by createBoundaryCondition().

createNodalSourceTerm()

std::unique_ptr< SourceTerm > ProcessLib::createNodalSourceTerm	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	st_mesh,
		std::unique_ptr< NumLib::LocalToGlobalIndexMap >	dof_table,
		std::size_t const	source_term_mesh_id,
		const int	variable_id,
		const int	component_id,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__type

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__Nodal__parameter

Definition at line 13 of file CreateNodalSourceTerm.cpp.

{
    DBUG("Constructing NodalSourceTerm from config.");
    config.checkConfigParameter("type", "Nodal");

    auto const param_name = config.getConfigParameter<std::string>("parameter");
    DBUG("Using parameter {:s} as nodal source term.", param_name);
 
    auto& param = ParameterLib::findParameter<double>(param_name, parameters, 1,
                                                      &st_mesh);
 
    return std::make_unique<NodalSourceTerm>(std::move(dof_table),
                                             source_term_mesh_id, st_mesh,
                                             variable_id, component_id, param);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createSourceTerm().

createOutput() [1/2]

std::vector< Output > ProcessLib::createOutput	(	const BaseLib::ConfigTree &	config,
		std::string const &	output_directory,
		std::vector< std::unique_ptr< MeshLib::Mesh > > &	meshes )

Definition at line 95 of file ProcessLib/Output/CreateOutput.cpp.

{
    std::vector<Output> outputs;
    auto oc = createOutputConfig(config, meshes);
    outputs.push_back(createOutput(std::move(oc), output_directory, meshes));
    return outputs;
}

References createOutput(), and createOutputConfig().

createOutput() [2/2]

Output ProcessLib::createOutput	(	OutputConfig &&	oc,
		std::string const &	output_directory,
		std::vector< std::unique_ptr< MeshLib::Mesh > > const &	meshes )

Definition at line 78 of file ProcessLib/Output/CreateOutput.cpp.

{
    auto output_format = createOutputFormat(
        output_directory, oc.output_type, std::move(oc.prefix),
        std::move(oc.suffix), oc.data_mode, oc.compress_output,
        oc.number_of_files, oc.chunk_size_bytes);
 
    OutputDataSpecification output_data_specification{
        std::move(oc.output_variables), std::move(oc.fixed_output_times),
        std::move(oc.repeats_each_steps), oc.output_extrapolation_residuals};
 
    return {std::move(output_format), oc.output_iteration_results,
            std::move(output_data_specification),
            std::move(oc.mesh_names_for_output), meshes};
}

References createOutputFormat().

Referenced by createOutput(), createOutputs(), createSubmeshResiduumOutputConfig(), and createTimeLoop().

createOutputConfig()

OutputConfig ProcessLib::createOutputConfig	(	const BaseLib::ConfigTree &	config,
		std::vector< std::unique_ptr< MeshLib::Mesh > > &	meshes )

Input File Parameter

prj__time_loop__output__type

Input File Parameter

prj__time_loop__output__prefix

Input File Parameter

prj__time_loop__output__suffix

Input File Parameter

prj__time_loop__output__compress_output

Input File Parameter

prj__time_loop__output__hdf

Input File Parameter

prj__time_loop__output__hdf__number_of_files

Input File Parameter

prj__time_loop__output__hdf__chunk_size_bytes

Input File Parameter

prj__time_loop__output__data_mode

Input File Parameter

prj__time_loop__output__fixed_output_times

Input File Parameter

prj__time_loop__output__fixed_output_times_from_file

Input File Parameter

prj__time_loop__output__timesteps

Input File Parameter

prj__time_loop__output__timesteps__pair

Input File Parameter

prj__time_loop__output__timesteps__pair__repeat

Input File Parameter

prj__time_loop__output__timesteps__pair__each_steps

Input File Parameter

prj__time_loop__output__variables

Input File Parameter

prj__time_loop__output__variables__variable

Input File Parameter

prj__time_loop__output__output_extrapolation_residuals

Input File Parameter

prj__time_loop__output__meshes

Input File Parameter

prj__time_loop__output__meshes__mesh

Input File Parameter

prj__time_loop__output__geometrical_sets

Input File Parameter

prj__time_loop__output__geometrical_sets__geometrical_set

Input File Parameter

prj__time_loop__output__geometrical_sets__geometrical_set__name

Input File Parameter

prj__time_loop__output__geometrical_sets__geometrical_set__geometry

Input File Parameter

prj__time_loop__output__output_iteration_results

Definition at line 70 of file CreateOutputConfig.cpp.

{
    OutputConfig output_config;
 
    output_config.output_type = [](auto output_type)
    {
        try
        {
            const std::map<std::string, OutputType> outputType_to_enum = {
                {"VTK", OutputType::vtk}, {"XDMF", OutputType::xdmf}};
            auto type = outputType_to_enum.at(output_type);
 
            return type;
        }
        catch (std::out_of_range&)
        {
            OGS_FATAL(
                "No supported file type provided. Read `{:s}' from <output><type> \
                in prj File. Supported: VTK, XDMF.",
                output_type);
        }
    }(config.getConfigParameter<std::string>("type"));
 
    output_config.prefix =
        config.getConfigParameter<std::string>("prefix", "{:meshname}");
 
    output_config.suffix =
        config.getConfigParameter<std::string>("suffix",
                                               "_ts_{:timestep}_t_{:time}");
 
    output_config.compress_output =
        config.getConfigParameter("compress_output", true);
 
    auto const hdf =
        config.getConfigSubtreeOptional("hdf");
 
    output_config.number_of_files = [&hdf]() -> unsigned int
    {
        if (hdf)
        {
            return hdf->getConfigParameter<unsigned int>("number_of_files");
        }
        return 1;
    }();
    output_config.chunk_size_bytes = [&hdf]() -> unsigned int
    {
        if (hdf)
        {
            return hdf->getConfigParameter<unsigned int>("chunk_size_bytes");
        }
        return 1048576;  // default chunk size in bytes according to
                         // https://www.hdfgroup.org/2022/10/improve-hdf5-performance-using-caching/
    }();
 
    output_config.data_mode =
        config.getConfigParameter<std::string>("data_mode", "Appended");
 
    //
    // Construction of output times
    //
 
    output_config.fixed_output_times =
        config.getConfigParameter<std::vector<double>>("fixed_output_times",
                                                       {});
    if (output_config.fixed_output_times.empty())
    {
        std::string filename = config.getConfigParameter<std::string>(
            "fixed_output_times_from_file", "no_file");
 
        if (filename != "no_file")
        {
            output_config.fixed_output_times =
                BaseLib::readDoublesFromBinaryFile(
                    filename, config.projectDirectory().string());
        }
    }
    // Remove possible duplicated elements and sort.
    BaseLib::makeVectorUnique(output_config.fixed_output_times);
 
    auto& repeats_each_steps = output_config.repeats_each_steps;

    if (auto const timesteps = config.getConfigSubtreeOptional("timesteps"))
    {
        for (auto pair : timesteps->getConfigSubtreeList("pair"))
        {
            auto repeat = pair.getConfigParameter<unsigned>("repeat");
            auto each_steps = pair.getConfigParameter<unsigned>("each_steps");
 
            assert(repeat != 0 && each_steps != 0);
            repeats_each_steps.emplace_back(repeat, each_steps);
        }
 
        if (repeats_each_steps.empty())
        {
            OGS_FATAL(
                "You have not given any pair (<repeat/>, <each_steps/>) that "
                "defines at which timesteps output shall be written. "
                "Aborting.");
        }
    }
    // In case nothing was specified, i.e. no explicit time steps or fixed
    // output times, every time step will be written.
    if (output_config.fixed_output_times.empty() &&
        output_config.repeats_each_steps.empty())
    {
        repeats_each_steps.emplace_back(1, 1);
    }

    auto const out_vars = config.getConfigSubtree("variables");
 
    auto& output_variables = output_config.output_variables;
    for (auto out_var :
         out_vars.getConfigParameterList<std::string>("variable"))
    {
        if (output_variables.find(out_var) != output_variables.cend())
        {
            OGS_FATAL("output variable `{:s}' specified more than once.",
                      out_var);
        }
 
        DBUG("adding output variable `{:s}'", out_var);
        output_variables.insert(out_var);
    }
 
    output_config.output_extrapolation_residuals =
        config.getConfigParameter<bool>("output_extrapolation_residuals",
                                        false);
 
    auto& mesh_names_for_output = output_config.mesh_names_for_output;
    if (auto const meshes_config = config.getConfigSubtreeOptional("meshes"))
    {
        if (output_config.prefix.find("{:meshname}") == std::string::npos)
        {
            OGS_FATAL(
                "There are multiple meshes defined in the output section of "
                "the project file, but the prefix doesn't contain "
                "'{{:meshname}}'. Thus the names for the files, the simulation "
                "results should be written to, would not be distinguishable "
                "for different meshes.");
        }
        for (auto mesh_config : meshes_config->getConfigParameterList("mesh"))
        {
            mesh_names_for_output.push_back(
                parseOutputMeshConfig(mesh_config, meshes));
            INFO("Configure mesh '{:s}' for output.",
                 mesh_names_for_output.back());
        }
    }
 
    if (auto const geometrical_sets_config =
        config.getConfigSubtreeOptional("geometrical_sets"))
    {
        for (
            auto geometrical_set_config :
            geometrical_sets_config->getConfigSubtreeList("geometrical_set"))
        {
            auto const geometrical_set_name =
                geometrical_set_config.getConfigParameter<std::string>("name",
                                                                       "");
            auto const geometry_name =
                geometrical_set_config.getConfigParameter<std::string>(
                    "geometry");
            mesh_names_for_output.push_back(geometrical_set_name + "_" +
                                            geometry_name);
        }
    }
 
    output_config.output_iteration_results =
        config.getConfigParameter<bool>("output_iteration_results", false);
 
    return output_config;
}

References ProcessLib::OutputConfig::chunk_size_bytes, ProcessLib::OutputConfig::compress_output, ProcessLib::OutputConfig::data_mode, DBUG(), ProcessLib::OutputConfig::fixed_output_times, BaseLib::ConfigTree::getConfigParameter(), BaseLib::ConfigTree::getConfigSubtree(), BaseLib::ConfigTree::getConfigSubtreeOptional(), INFO(), BaseLib::makeVectorUnique(), ProcessLib::OutputConfig::mesh_names_for_output, ProcessLib::OutputConfig::number_of_files, OGS_FATAL, ProcessLib::OutputConfig::output_extrapolation_residuals, ProcessLib::OutputConfig::output_iteration_results, ProcessLib::OutputConfig::output_type, ProcessLib::OutputConfig::output_variables, parseOutputMeshConfig(), ProcessLib::OutputConfig::prefix, BaseLib::ConfigTree::projectDirectory(), BaseLib::readDoublesFromBinaryFile(), ProcessLib::OutputConfig::repeats_each_steps, ProcessLib::OutputConfig::suffix, vtk, and xdmf.

Referenced by createOutput(), createOutputs(), and createSubmeshResiduumOutputConfig().

createOutputFormat()

std::unique_ptr< OutputFormat > ProcessLib::createOutputFormat	(	std::string const &	output_directory,
		OutputType const	output_type,
		std::string	prefix,
		std::string	suffix,
		std::string const &	data_mode,
		bool const	compress_output,
		unsigned int const	number_of_files,
		unsigned int const	chunk_size_bytes )

Definition at line 54 of file ProcessLib/Output/CreateOutput.cpp.

{
    switch (output_type)
    {
        case OutputType::vtk:
            return std::make_unique<OutputVTKFormat>(
                output_directory, std::move(prefix), std::move(suffix),
                compress_output, convertVtkDataMode(data_mode));
        case OutputType::xdmf:
            return std::make_unique<OutputXDMFHDF5Format>(
                output_directory, std::move(prefix), std::move(suffix),
                compress_output, number_of_files, chunk_size_bytes);
        default:
            OGS_FATAL(
                "No supported file type provided. Read '{}' from "
                "<output><type> in prj file. Supported: VTK, XDMF.",
                BaseLib::to_underlying(output_type));
    }
}

References OGS_FATAL, BaseLib::to_underlying(), vtk, and xdmf.

Referenced by createOutput().

createOutputs()

std::vector< Output > ProcessLib::createOutputs	(	const BaseLib::ConfigTree &	output_configs,
		std::string const &	output_directory,
		std::vector< std::unique_ptr< MeshLib::Mesh > > &	meshes )

Input File Parameter

prj__time_loop__outputs__output

Definition at line 106 of file ProcessLib/Output/CreateOutput.cpp.

{
    DBUG("Parse outputs configuration:");
    std::vector<Output> outputs;
    for (auto const& output_config :
         output_configs.getConfigSubtreeList("output"))
    {
        auto oc = createOutputConfig(output_config, meshes);
        outputs.push_back(
            createOutput(std::move(oc), output_directory, meshes));
    }
    if (areOutputNamesUnique(outputs))
    {
        return outputs;
    }
    else
    {
        OGS_FATAL(
            "Output configuration paths are not unique. This will lead to "
            "overwritten results or invalid / corrupted data within the "
            "files.");
    }
}

References createOutput(), createOutputConfig(), DBUG(), BaseLib::ConfigTree::getConfigSubtreeList(), and OGS_FATAL.

Referenced by createTimeLoop().

createPerProcessData()

std::vector< std::unique_ptr< ProcessData > > ProcessLib::createPerProcessData	(	BaseLib::ConfigTree const &	config,
		std::vector< std::unique_ptr< Process > > const &	processes,
		std::map< std::string, std::unique_ptr< NumLib::NonlinearSolverBase > > const &	nonlinear_solvers,
		bool const	compensate_non_equilibrium_initial_residuum,
		std::vector< double > const &	fixed_times_for_output )

Input File Parameter

prj__time_loop__processes__process

Input File Parameter

prj__time_loop__processes__process__ref

Input File Parameter

prj__time_loop__processes__process__process_name

Input File Parameter

prj__time_loop__processes__process__nonlinear_solver

Input File Parameter

prj__time_loop__processes__process__time_discretization

Input File Parameter

prj__time_loop__processes__process__time_stepping

Input File Parameter

prj__time_loop__processes__process__convergence_criterion

Input File Parameter

prj__time_loop__processes__process__output

Definition at line 63 of file CreateProcessData.cpp.

{
    std::vector<std::unique_ptr<ProcessData>> per_process_data;
    std::vector<std::string> process_names;
    int process_id = 0;

    for (auto pcs_config : config.getConfigSubtreeList("process"))
    {
        auto const pcs_name = pcs_config.getConfigAttribute<std::string>("ref");
        auto& pcs = *BaseLib::getIfOrError(
            processes,
            [&pcs_name](std::unique_ptr<Process> const& p)
            { return p->name == pcs_name; },
            "A process with the given name has not been defined.");
 
        auto const process_name =
            pcs_config.getConfigParameter<std::string>("process_name", "");
        if (process_name != "")
        {
            if (ranges::contains(process_names, process_name))
            {
                OGS_FATAL(
                    "The given process name is not unique! Please check the "
                    "element "
                    "'time_loop/process/name' in the project file. Found "
                    "duplicate "
                    "process name '{:s}'.",
                    process_name);
            }
            process_names.emplace_back(process_name);
        }
 
        auto const nl_slv_name =
            pcs_config.getConfigParameter<std::string>("nonlinear_solver");
        auto& nl_slv = *BaseLib::getOrError(
            nonlinear_solvers, nl_slv_name,
            "A nonlinear solver with the given name has not been defined.");
 
        auto time_disc = NumLib::createTimeDiscretization(
            pcs_config.getConfigSubtree("time_discretization"));
 
        auto timestepper = NumLib::createTimeStepper(
            pcs_config.getConfigSubtree("time_stepping"),
            fixed_times_for_output);
 
        auto conv_crit = NumLib::createConvergenceCriterion(
            pcs_config.getConfigSubtree("convergence_criterion"));

        auto output = pcs_config.getConfigSubtreeOptional("output");
        if (output)
        {
            OGS_FATAL(
                "In order to make the specification of output in the project "
                "file consistent, the variables output tags were moved from "
                "xpath "
                "'//OpenGeoSysProject/time_loop/processes/process/output' to "
                "the global output section, i.e., to the xpath "
                "'//OpenGeoSysProject/time_loop/output'. This has to be done "
                "in the current project file!");
        }
 
        per_process_data.emplace_back(makeProcessData(
            std::move(timestepper), nl_slv, process_id, std::move(process_name),
            pcs, std::move(time_disc), std::move(conv_crit),
            compensate_non_equilibrium_initial_residuum));
        ++process_id;
    }
 
    if (per_process_data.size() != processes.size())
    {
        if (processes.size() > 1)
        {
            OGS_FATAL(
                "Some processes have not been configured to be solved by this  "
                "time loop.");
        }
        else
        {
            INFO(
                "The equations of the coupled processes will be solved by the "
                "staggered scheme.");
        }
    }
 
    return per_process_data;
}

References NumLib::createConvergenceCriterion(), NumLib::createTimeDiscretization(), NumLib::createTimeStepper(), BaseLib::ConfigTree::getConfigSubtreeList(), BaseLib::getIfOrError(), BaseLib::getOrError(), INFO(), makeProcessData(), and OGS_FATAL.

Referenced by createTimeLoop().

createPhaseFieldIrreversibleDamageOracleBoundaryCondition()

std::unique_ptr< PhaseFieldIrreversibleDamageOracleBoundaryCondition > ProcessLib::createPhaseFieldIrreversibleDamageOracleBoundaryCondition	(	NumLib::LocalToGlobalIndexMap const &	dof_table,
		MeshLib::Mesh const &	mesh,
		int const	variable_id,
		int const	component_id )

Definition at line 74 of file PhaseFieldIrreversibleDamageOracleBoundaryCondition.cpp.

{
    DBUG("Constructing PhaseFieldIrreversibleDamageOracleBoundaryCondition.");
 
    return std::make_unique<
        PhaseFieldIrreversibleDamageOracleBoundaryCondition>(
        dof_table, mesh, variable_id, component_id);
}

References DBUG().

Referenced by createBoundaryCondition().

createPrimaryVariableConstraintDirichletBoundaryCondition()

std::unique_ptr< PrimaryVariableConstraintDirichletBoundaryCondition > ProcessLib::createPrimaryVariableConstraintDirichletBoundaryCondition	(	PrimaryVariableConstraintDirichletBoundaryConditionConfig const &	config,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		int const	variable_id,
		int const	component_id,
		const std::vector< std::unique_ptr< ParameterLib::ParameterBase > > &	parameters )

Definition at line 124 of file PrimaryVariableConstraintDirichletBoundaryCondition.cpp.

{
    DBUG("Constructing PrimaryVariableConstraintDirichletBoundaryCondition.");
 
    auto& parameter = ParameterLib::findParameter<double>(
        config.parameter_name, parameters, 1, &bc_mesh);
 
    auto& threshold_parameter = ParameterLib::findParameter<double>(
        config.threshold_parameter_name, parameters, 1, &bc_mesh);
 
    if (config.comparison_operator_string != "greater" &&
        config.comparison_operator_string != "less")
    {
        OGS_FATAL(
            "The comparison operator is '{:s}', but has to be either "
            "'greater' or 'less'.",
            config.comparison_operator_string);
    }
    bool const less = config.comparison_operator_string == "less";
 
// In case of partitioned mesh the boundary could be empty, i.e. there is no
// boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<
        PrimaryVariableConstraintDirichletBoundaryCondition>(
        parameter, bc_mesh, dof_table_bulk, variable_id, component_id,
        threshold_parameter, less);
}

References ProcessLib::PrimaryVariableConstraintDirichletBoundaryConditionConfig::comparison_operator_string, DBUG(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), OGS_FATAL, ProcessLib::PrimaryVariableConstraintDirichletBoundaryConditionConfig::parameter_name, and ProcessLib::PrimaryVariableConstraintDirichletBoundaryConditionConfig::threshold_parameter_name.

Referenced by createBoundaryCondition().

createProcessOutputData()

ProcessOutputData ProcessLib::createProcessOutputData	(	Process const &	process,
		std::size_t const	n_processes,
		MeshLib::Mesh &	output_mesh )

Extracts data necessary for output from the given process.

Definition at line 136 of file ProcessOutputData.cpp.

{
    auto bulk_mesh_dof_tables =
        getDofTablesOfAllProcesses(process, n_processes);
 
    auto [output_mesh_dof_tables, container_that_owns_output_mesh_dof_tables] =
        computeOutputMeshDofTables(process, output_mesh, bulk_mesh_dof_tables);
 
    return {getProcessVariablesOfAllProcesses(process, n_processes),
            process.getSecondaryVariables(),
            ::getIntegrationPointWriters(process, output_mesh),
            std::move(bulk_mesh_dof_tables),
            std::move(output_mesh_dof_tables),
            std::move(container_that_owns_output_mesh_dof_tables),
            output_mesh};
}

References ProcessLib::Process::getSecondaryVariables().

Referenced by ProcessLib::Output::doOutputAlways(), ProcessLib::Output::doOutputNonlinearIteration(), and ProcessLib::Output::prepareSubmesh().

createPythonBoundaryCondition()

std::unique_ptr< PythonBoundaryCondition > ProcessLib::createPythonBoundaryCondition	(	PythonBoundaryConditionConfig const &	config,
		MeshLib::Mesh const &	boundary_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		MeshLib::Mesh const &	bulk_mesh,
		int const	variable_id,
		int const	component_id,
		unsigned const	integration_order,
		unsigned const	shapefunction_order,
		std::vector< std::reference_wrapper< ProcessVariable > > const &	all_process_variables_for_this_process )

Creates a new PythonBoundaryCondition object.

Definition at line 276 of file PythonBoundaryCondition.cpp.

{
    // Evaluate Python code in scope of main module
    pybind11::object scope =
        pybind11::module::import("__main__").attr("__dict__");
 
    if (!scope.contains(config.bc_object))
    {
        OGS_FATAL(
            "Function `{:s}' is not defined in the python script file, or "
            "there was no python script file specified.",
            config.bc_object);
    }
 
    auto* bc = scope[config.bc_object.c_str()]
                   .cast<PythonBoundaryConditionPythonSideInterface*>();
 
    if (variable_id >=
            static_cast<int>(dof_table_bulk.getNumberOfVariables()) ||
        component_id >=
            dof_table_bulk.getNumberOfVariableComponents(variable_id))
    {
        OGS_FATAL(
            "Variable id or component id too high. Actual values: ({:d}, "
            "{:d}), maximum values: ({:d}, {:d}).",
            variable_id, component_id, dof_table_bulk.getNumberOfVariables(),
            dof_table_bulk.getNumberOfVariableComponents(variable_id));
    }
 
    // In case of partitioned mesh the boundary could be empty, i.e. there is no
    // boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (boundary_mesh.getDimension() == 0 &&
        boundary_mesh.getNumberOfNodes() == 0 &&
        boundary_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<PythonBoundaryCondition>(
        PythonBcData{
            {bc, dof_table_bulk.getGlobalComponent(variable_id, component_id),
             boundary_mesh, all_process_variables_for_this_process,
             shapefunction_order}},
        integration_order, config.flush_stdout, bulk_mesh.getDimension(),
        dof_table_bulk);
}

References ProcessLib::PythonBoundaryConditionConfig::bc_object, ProcessLib::PythonBoundaryConditionConfig::flush_stdout, MeshLib::Mesh::getDimension(), NumLib::LocalToGlobalIndexMap::getGlobalComponent(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), NumLib::LocalToGlobalIndexMap::getNumberOfVariableComponents(), NumLib::LocalToGlobalIndexMap::getNumberOfVariables(), and OGS_FATAL.

Referenced by createBoundaryCondition().

createPythonSourceTerm()

std::unique_ptr< SourceTerm > ProcessLib::createPythonSourceTerm	(	BaseLib::ConfigTree const &	config,
		MeshLib::Mesh const &	source_term_mesh,
		std::unique_ptr< NumLib::LocalToGlobalIndexMap >	dof_table,
		int const	variable_id,
		int const	component_id,
		unsigned const	integration_order,
		unsigned const	shapefunction_order,
		unsigned const	global_dim,
		std::vector< std::reference_wrapper< ProcessVariable > > const &	all_process_variables_for_this_process )

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__type

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__Python__source_term_object

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__Python__flush_stdout

Definition at line 17 of file CreatePythonSourceTerm.cpp.

{
    DBUG("Constructing PythonSourceTerm from config.");
    config.checkConfigParameter("type", "Python");
 
    auto const source_term_object =
        config.getConfigParameter<std::string>("source_term_object");
    auto const flush_stdout = config.getConfigParameter("flush_stdout", false);
 
    // Evaluate Python code in scope of main module
    pybind11::object scope =
        pybind11::module::import("__main__").attr("__dict__");
 
    if (!scope.contains(source_term_object))
    {
        OGS_FATAL(
            "Function `{:s}' is not defined in the python script file, or "
            "there was no python script file specified.",
            source_term_object);
    }
 
    auto* source_term = scope[source_term_object.c_str()]
                            .cast<ProcessLib::SourceTerms::Python::
                                      PythonSourceTermPythonSideInterface*>();
 
    // In case of partitioned mesh the source_term could be empty, i.e. there is
    // no source_term condition.
#ifdef USE_PETSC
    // This can be extracted to createSourceTerm() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createSourceTerm().
    if (source_term_mesh.getDimension() == 0 &&
        source_term_mesh.getNumberOfNodes() == 0 &&
        source_term_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    auto const global_component_id =
        dof_table->getGlobalComponent(variable_id, component_id);
    return std::make_unique<ProcessLib::SourceTerms::Python::PythonSourceTerm>(
        std::move(dof_table),
        ProcessLib::SourceTerms::Python::PythonStData{
            {source_term, global_component_id, source_term_mesh,
             all_process_variables_for_this_process, shapefunction_order}},
        integration_order, global_dim, flush_stdout);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), and OGS_FATAL.

Referenced by createSourceTerm().

createReleaseNodalForce()

std::unique_ptr< BoundaryCondition > ProcessLib::createReleaseNodalForce	(	unsigned const	global_dim,
		int const	variable_id,
		std::string const &	decay_parameter_name,
		BoundaryConditionConfig const &	bc_config,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Definition at line 46 of file CreateReleaseNodalForce.cpp.

{
    DBUG("Create ReleaseNodalForce boundary condition.");
 
    if (!bc_config.compensate_non_equilibrium_initial_residuum)
    {
        OGS_FATAL(
            "The compensate_non_equilibrium_initial_residuum must be set for "
            "the ReleaseNodalForce boundary condition.");
    }
 
    auto const& time_decay_parameter = ParameterLib::findParameter<double>(
        decay_parameter_name, parameters, 1, &bc_mesh);
 
    // In case of partitioned mesh the boundary could be empty, i.e. there
    // is no boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the
    // config parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of
    // the subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    if (bc_mesh.getDimension() >= global_dim)
    {
        OGS_FATAL(
            "The dimension ({:d}) of the given boundary mesh '{:s}' is not "
            "lower than the bulk dimension ({:d}).",
            bc_mesh.getDimension(), bc_mesh.getName(), global_dim);
    }
 
    // Create component ids vector for the current variable.
    auto const& number_of_components =
        dof_table_bulk.getNumberOfVariableComponents(variable_id);
    std::vector<int> component_ids =
        ranges::views::iota(0, number_of_components) | ranges::to_vector;
 
    // BC mesh subset creation
    std::vector<MeshLib::Node*> const bc_nodes = bc_mesh.getNodes();
    DBUG("Found {:d} nodes for Natural BCs for the variable {:d}",
         bc_nodes.size(), variable_id);
 
    MeshLib::MeshSubset bc_mesh_subset(bc_mesh, bc_nodes);
 
    // Create local DOF table from the BC mesh subset for the given variable
    // and component ids.
    auto dof_table_boundary = dof_table_bulk.deriveBoundaryConstrainedMap(
        variable_id, std::move(component_ids), std::move(bc_mesh_subset));
 
    ParameterLib::SpatialPosition pos;
    pos.setNodeID(0);
    pos.setCoordinates(MathLib::Point3d{});
    if (time_decay_parameter(0, pos).front() - 1.0 >
        std::numeric_limits<double>::epsilon())
    {
        OGS_FATAL(
            "The time_decay_parameter '{:s}' must be equal to 1.0 at t=0.0. "
            "and decrease over time to 0. ",
            decay_parameter_name);
    }
 
    return std::make_unique<ReleaseNodalForce>(
        variable_id, bc_mesh, dof_table_boundary, time_decay_parameter);
}

References ProcessLib::BoundaryConditionConfig::compensate_non_equilibrium_initial_residuum, DBUG(), NumLib::LocalToGlobalIndexMap::deriveBoundaryConstrainedMap(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getName(), MeshLib::Mesh::getNodes(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), NumLib::LocalToGlobalIndexMap::getNumberOfVariableComponents(), OGS_FATAL, ParameterLib::SpatialPosition::setCoordinates(), and ParameterLib::SpatialPosition::setNodeID().

Referenced by createBoundaryCondition().

createRobinBoundaryCondition()

std::unique_ptr< RobinBoundaryCondition > ProcessLib::createRobinBoundaryCondition	(	RobinBoundaryConditionConfig const &	config,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		int const	variable_id,
		int const	component_id,
		unsigned const	integration_order,
		unsigned const	shapefunction_order,
		unsigned const	global_dim,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Creates a new uniform Robin boundary condition from the given data.

The Robin boundary condition is given in the form \( \alpha \cdot [ u_0 - u(x) ] \), where the coefficients \( \alpha \) and \( u_0 \) are obtained from the config, and \( u \) is the unknown to which the boundary condition is applied.

The value \( \alpha \cdot [ u_0 - u(x) ] \) is a flux. It replaces the integrand in the boundary integral for the variable \( u \).

Definition at line 34 of file RobinBoundaryCondition.cpp.

{
    DBUG("Constructing RobinBcConfig.");
 
    if (bc_mesh.getDimension() >= global_dim)
    {
        OGS_FATAL(
            "The dimension ({:d}) of the given boundary mesh '{:s}' is not "
            "lower than the bulk dimension ({:d}).",
            bc_mesh.getDimension(), bc_mesh.getName(), global_dim);
    }
 
    auto const& alpha = ParameterLib::findParameter<double>(
        config.alpha_name, parameters, 1, &bc_mesh);
    auto const& u_0 = ParameterLib::findParameter<double>(
        config.u_0_name, parameters, 1, &bc_mesh);
 
    ParameterLib::Parameter<double> const* integral_measure(nullptr);
    if (global_dim - bc_mesh.getDimension() != 1)
    {
        if (!config.area_parameter_name)
        {
            OGS_FATAL("{}: tag <area_parameter> required in Robin BC.",
                      __FUNCTION__);
        }
        integral_measure = &ParameterLib::findParameter<double>(
            config.area_parameter_name.value(), parameters, 1, &bc_mesh);
    }
 
    // In case of partitioned mesh the boundary could be empty, i.e. there is no
    // boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<RobinBoundaryCondition>(
        integration_order, shapefunction_order, dof_table, variable_id,
        component_id, global_dim, bc_mesh,
        RobinBoundaryConditionData{alpha, u_0, integral_measure});
}

References ProcessLib::RobinBoundaryConditionConfig::alpha_name, ProcessLib::RobinBoundaryConditionConfig::area_parameter_name, DBUG(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getName(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), OGS_FATAL, and ProcessLib::RobinBoundaryConditionConfig::u_0_name.

Referenced by createBoundaryCondition().

createSecondaryVariables()

void ProcessLib::createSecondaryVariables	(	BaseLib::ConfigTree const &	config,
		SecondaryVariableCollection &	secondary_variables )

Input File Parameter

prj__processes__process__secondary_variables

Input File Parameter

prj__processes__process__secondary_variables__secondary_variable

Input File Parameter

prj__processes__process__secondary_variables__secondary_variable__type

Input File Parameter

prj__processes__process__secondary_variables__secondary_variable__name

Input File Parameter

prj__processes__process__secondary_variables__secondary_variable__internal_name

Input File Parameter

prj__processes__process__secondary_variables__secondary_variable__output_name

Definition at line 11 of file CreateSecondaryVariables.cpp.

{
    auto sec_vars_config =
        config.getConfigSubtreeOptional("secondary_variables");
    if (!sec_vars_config)
    {
        return;
    }
 
    for (
        auto sec_var_config :
        sec_vars_config->getConfigSubtreeList("secondary_variable"))
    {
        auto const type =
            sec_var_config.getConfigAttributeOptional<std::string>("type");
        if (type)
        {
            WARN(
                "Secondary variable type specification is deprecated and is "
                "ignored. All secondary variable types are 'static'.");
        }
 
        auto const [internal_name, output_name] =
            [&sec_var_config]() -> std::pair<std::string, std::string>
        {
            auto const name =
                sec_var_config.getConfigAttributeOptional<std::string>("name");
            if (name)
            {
                return {*name, *name};
            }
            else
            {
                auto const internal_name =
                    sec_var_config.getConfigAttribute<std::string>(
                        "internal_name");
                auto const output_name =
                    sec_var_config.getConfigAttribute<std::string>(
                        "output_name");
                return {internal_name, output_name};
            }
        }();
 
        secondary_variables.addNameMapping(internal_name, output_name);
    }
}

References ProcessLib::SecondaryVariableCollection::addNameMapping(), BaseLib::ConfigTree::getConfigSubtreeOptional(), and WARN().

Referenced by ProcessLib::ComponentTransport::createComponentTransportProcess(), ProcessLib::HeatConduction::createHeatConductionProcess(), ProcessLib::HeatTransportBHE::createHeatTransportBHEProcess(), ProcessLib::HMPhaseField::createHMPhaseFieldProcess(), ProcessLib::HT::createHTProcess(), ProcessLib::HydroMechanics::createHydroMechanicsProcess(), ProcessLib::LIE::HydroMechanics::createHydroMechanicsProcess(), ProcessLib::LargeDeformation::createLargeDeformationProcess(), ProcessLib::LiquidFlow::createLiquidFlowProcess(), ProcessLib::PhaseField::createPhaseFieldProcess(), ProcessLib::RichardsComponentTransport::createRichardsComponentTransportProcess(), ProcessLib::RichardsFlow::createRichardsFlowProcess(), ProcessLib::RichardsMechanics::createRichardsMechanicsProcess(), ProcessLib::LIE::SmallDeformation::createSmallDeformationProcess(), ProcessLib::SmallDeformation::createSmallDeformationProcess(), ProcessLib::SteadyStateDiffusion::createSteadyStateDiffusion(), ProcessLib::TH2M::createTH2MProcess(), ProcessLib::ThermalTwoPhaseFlowWithPP::createThermalTwoPhaseFlowWithPPProcess(), ProcessLib::ThermoHydroMechanics::createThermoHydroMechanicsProcess(), ProcessLib::ThermoMechanics::createThermoMechanicsProcess(), ProcessLib::ThermoRichardsFlow::createThermoRichardsFlowProcess(), ProcessLib::ThermoRichardsMechanics::createThermoRichardsMechanicsProcessStage2(), ProcessLib::TwoPhaseFlowWithPP::createTwoPhaseFlowWithPPProcess(), and ProcessLib::WellboreSimulator::createWellboreSimulatorProcess().

createSolutionDependentDirichletBoundaryCondition()

std::unique_ptr< SolutionDependentDirichletBoundaryCondition > ProcessLib::createSolutionDependentDirichletBoundaryCondition	(	SolutionDependentDirichletBoundaryConditionConfig const &	config,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		int const	variable_id,
		int const	component_id,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Definition at line 113 of file SolutionDependentDirichletBoundaryCondition.cpp.

{
    DBUG("Constructing SolutionDependentDirichletBoundaryCondition.");
 
    auto& initial_value_parameter = ParameterLib::findParameter<double>(
        config.initial_value_parameter_string, parameters, 1, &bc_mesh);
 
// In case of partitioned mesh the boundary could be empty, i.e. there is no
// boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<SolutionDependentDirichletBoundaryCondition>(
        config.property_name, initial_value_parameter, bc_mesh, dof_table_bulk,
        variable_id, component_id);
}

References DBUG(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), ProcessLib::SolutionDependentDirichletBoundaryConditionConfig::initial_value_parameter_string, and ProcessLib::SolutionDependentDirichletBoundaryConditionConfig::property_name.

Referenced by createBoundaryCondition().

createSourceTerm()

std::unique_ptr< SourceTermBase > ProcessLib::createSourceTerm	(	const SourceTermConfig &	config,
		const NumLib::LocalToGlobalIndexMap &	dof_table_bulk,
		const MeshLib::Mesh &	source_term_mesh,
		const int	variable_id,
		const unsigned	integration_order,
		const unsigned	shapefunction_order,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		std::vector< std::reference_wrapper< ProcessVariable > > const &	all_process_variables_for_this_process,
		const MeshLib::Mesh &	bulk_mesh )

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__type

Definition at line 19 of file CreateSourceTerm.cpp.

{
    auto const type = config.config.peekConfigParameter<std::string>("type");
 
    // check basic data consistency
    if (variable_id >=
            static_cast<int>(dof_table_bulk.getNumberOfVariables()) ||
        config.component_id >=
            dof_table_bulk.getNumberOfVariableComponents(variable_id))
    {
        OGS_FATAL(
            "Variable id or component id too high. Actual values: ({:d}, "
            "{:d}), maximum values: ({:d}, {:d}).",
            variable_id, config.component_id,
            dof_table_bulk.getNumberOfVariables(),
            dof_table_bulk.getNumberOfVariableComponents(variable_id));
    }
 
    if (!source_term_mesh.getProperties()
             .template existsPropertyVector<std::size_t>(
                 MeshLib::getBulkIDString(MeshLib::MeshItemType::Node)) &&
        (type != "EmbeddedAnchor"))
    {
        OGS_FATAL(
            "The required bulk node ids map does not exist in the source term "
            "mesh '{:s}'.",
            source_term_mesh.getName());
    }
    std::vector<MeshLib::Node*> const& source_term_nodes =
        source_term_mesh.getNodes();
    DBUG(
        "Found {:d} nodes for source term at mesh '{:s}' for the variable {:d} "
        "and component {:d}",
        source_term_nodes.size(), source_term_mesh.getName(), variable_id,
        config.component_id);
 
    MeshLib::MeshSubset source_term_mesh_subset(source_term_mesh,
                                                source_term_nodes);
 
    if (type == "Nodal")
    {
        auto dof_table_source_term =
            dof_table_bulk.deriveBoundaryConstrainedMap(
                variable_id, {config.component_id},
                std::move(source_term_mesh_subset));
        return ProcessLib::createNodalSourceTerm(
            config.config, config.mesh, std::move(dof_table_source_term),
            source_term_mesh.getID(), variable_id, config.component_id,
            parameters);
    }
    if (type == "Anchor")
    {
        const int number_of_components =
            dof_table_bulk.getNumberOfVariableComponents(variable_id);
        std::vector<int> component_ids(number_of_components);
        std::iota(std::begin(component_ids), std::end(component_ids), 0);
        auto dof_table_source_term =
            dof_table_bulk.deriveBoundaryConstrainedMap(
                variable_id, component_ids, std::move(source_term_mesh_subset));
        const int bulk_mesh_dimension =
            dof_table_bulk.getMeshSubset(variable_id, 0)
                .getMesh()
                .getDimension();
        if (bulk_mesh_dimension != number_of_components)
        {
            OGS_FATAL(
                "For the Anchor source term type,"
                "the bulk mesh dimension needs to be the same "
                "as the number of process variable components.");
        }
        switch (bulk_mesh_dimension)
        {
            case 2:
                return ProcessLib::createAnchorTerm<2>(
                    config.config, config.mesh,
                    std::move(dof_table_source_term), source_term_mesh.getID(),
                    variable_id, parameters);
            case 3:
                return ProcessLib::createAnchorTerm<3>(
                    config.config, config.mesh,
                    std::move(dof_table_source_term), source_term_mesh.getID(),
                    variable_id, parameters);
            default:
                OGS_FATAL(
                    "Anchor can not be instantiated "
                    "for mesh dimensions other than two or three. "
                    "{}-dimensional mesh was given.",
                    bulk_mesh_dimension);
        }
    }
    if (type == "EmbeddedAnchor")
    {
        const int number_of_components =
            dof_table_bulk.getNumberOfVariableComponents(variable_id);
 
        const int bulk_mesh_dimension = bulk_mesh.getDimension();
        if (bulk_mesh_dimension != number_of_components)
        {
            OGS_FATAL(
                "For the EmbeddedAnchor source term type,"
                "the bulk mesh dimension needs to be the same "
                "as the number of process variable components.");
        }
        switch (bulk_mesh_dimension)
        {
            case 2:
                return ProcessLib::createEmbeddedAnchor<2>(
                    config.config, config.mesh, bulk_mesh, dof_table_bulk,
                    source_term_mesh.getID(), variable_id);
            case 3:
                return ProcessLib::createEmbeddedAnchor<3>(
                    config.config, config.mesh, bulk_mesh, dof_table_bulk,
                    source_term_mesh.getID(), variable_id);
            default:
                OGS_FATAL(
                    "Anchor can not be instantiated "
                    "for mesh dimensions other than two or three. "
                    "{}-dimensional mesh was given.",
                    bulk_mesh_dimension);
        }
    }
    if (type == "Line" || type == "Volumetric")
    {
        auto dof_table_source_term =
            dof_table_bulk.deriveBoundaryConstrainedMap(
                variable_id, {config.component_id},
                std::move(source_term_mesh_subset));
        auto const& bulk_mesh_dimension =
            dof_table_bulk.getMeshSubset(variable_id, config.component_id)
                .getMesh()
                .getDimension();
        return ProcessLib::createVolumetricSourceTerm(
            config.config, bulk_mesh_dimension, config.mesh,
            std::move(dof_table_source_term), parameters, integration_order,
            shapefunction_order);
    }
    if (type == "Python")
    {
        auto dof_table_source_term =
            dof_table_bulk.deriveBoundaryConstrainedMap(
                std::move(source_term_mesh_subset));
 
        return ProcessLib::createPythonSourceTerm(
            config.config, config.mesh, std::move(dof_table_source_term),
            variable_id, config.component_id, integration_order,
            shapefunction_order, source_term_mesh.getDimension(),
            all_process_variables_for_this_process);
    }
 
    OGS_FATAL("Unknown source term type: `{:s}'.", type);
}

References ProcessLib::SourceTermConfig::component_id, ProcessLib::SourceTermConfig::config, createAnchorTerm< 2 >(), createAnchorTerm< 3 >(), createEmbeddedAnchor< 2 >(), createEmbeddedAnchor< 3 >(), createNodalSourceTerm(), createPythonSourceTerm(), createVolumetricSourceTerm(), DBUG(), NumLib::LocalToGlobalIndexMap::deriveBoundaryConstrainedMap(), MeshLib::getBulkIDString(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getID(), MeshLib::MeshSubset::getMesh(), NumLib::LocalToGlobalIndexMap::getMeshSubset(), MeshLib::Mesh::getName(), MeshLib::Mesh::getNodes(), NumLib::LocalToGlobalIndexMap::getNumberOfVariableComponents(), NumLib::LocalToGlobalIndexMap::getNumberOfVariables(), MeshLib::Mesh::getProperties(), ProcessLib::SourceTermConfig::mesh, MeshLib::Node, OGS_FATAL, and BaseLib::ConfigTree::peekConfigParameter().

Referenced by ProcessLib::ProcessVariable::createSourceTerms().

createSubmeshResiduumOutputConfig()

SubmeshResiduumOutputConfig ProcessLib::createSubmeshResiduumOutputConfig	(	BaseLib::ConfigTree const &	config,
		std::string const &	output_directory,
		std::vector< std::unique_ptr< MeshLib::Mesh > > &	meshes )

Definition at line 203 of file SubmeshResiduumOutputConfig.cpp.

{
    auto oc = createOutputConfig(config, meshes);
 
    if (oc.mesh_names_for_output.empty())
    {
        OGS_FATAL(
            "You did not specify any meshes for submesh residuum output.");
    }
 
    if (!areElementsUnique(oc.mesh_names_for_output))
    {
        OGS_FATAL("The mesh names for submesh residuum output are not unique.");
    }
 
    auto const meshes_filtered =
        filterMeshesForResiduumOutput(meshes, oc.mesh_names_for_output);
 
    for (auto const& mesh : meshes_filtered)
    {
        checkBulkIDMappingsPresent(mesh.get());
    }
 
    auto const& bulk_mesh =
        *meshes.front();  // convention: the first mesh is the bulk mesh
    checkNonOverlappingCover(bulk_mesh, meshes_filtered);
 
    return {createOutput(std::move(oc), output_directory, meshes),
            std::move(meshes_filtered)};
}

References createOutput(), createOutputConfig(), and OGS_FATAL.

Referenced by createTimeLoop().

createTimeDecayDirichletBoundaryCondition()

std::unique_ptr< BoundaryCondition > ProcessLib::createTimeDecayDirichletBoundaryCondition	(	TimeDecayDirichletBoundaryConditionConfig const &	config,
		int const	variable_id,
		int const	component_id,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_bulk,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Definition at line 37 of file CreateTimeDecayDirichletBoundaryCondition.cpp.

{
    DBUG("Create TimeDecayDirichlet.");
    auto const& time_decay_parameter = ParameterLib::findParameter<double>(
        config.parameter_name, parameters, 1, &bc_mesh);
 
    // In case of partitioned mesh the boundary could be empty, i.e. there
    // is no boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<TimeDecayDirichletBoundaryCondition>(
        variable_id, component_id, bc_mesh, dof_table_bulk,
        time_decay_parameter, config.lower_limit);
}

References DBUG(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), ProcessLib::TimeDecayDirichletBoundaryConditionConfig::lower_limit, and ProcessLib::TimeDecayDirichletBoundaryConditionConfig::parameter_name.

Referenced by createBoundaryCondition().

createTimeLoop()

std::unique_ptr< TimeLoop > ProcessLib::createTimeLoop	(	BaseLib::ConfigTree const &	config,
		std::string const &	output_directory,
		const std::vector< std::unique_ptr< Process > > &	processes,
		const std::map< std::string, std::unique_ptr< NumLib::NonlinearSolverBase > > &	nonlinear_solvers,
		std::vector< std::unique_ptr< MeshLib::Mesh > > &	meshes,
		bool const	compensate_non_equilibrium_initial_residuum )

Builds a TimeLoop from the given configuration.

Input File Parameter

prj__time_loop__output

Input File Parameter

prj__time_loop__outputs

Input File Parameter

prj__time_loop__submesh_residuum_output

Input File Parameter

prj__time_loop__processes

Definition at line 22 of file CreateTimeLoop.cpp.

{
    auto output_config_tree = config.getConfigSubtreeOptional("output");
    if (!output_config_tree)
    {
        INFO("No output section found.");
    }
    auto outputs =
        output_config_tree
            ? createOutput(*output_config_tree, output_directory, meshes)
            : createOutputs(config.getConfigSubtree("outputs"),
                            output_directory, meshes);
    auto const fixed_times_for_output =
        calculateUniqueFixedTimesForAllOutputs(outputs);
 
    if (auto const submesh_residuum_output_config_tree =
        config.getConfigSubtreeOptional("submesh_residuum_output");
        submesh_residuum_output_config_tree)
    {
        auto smroc = createSubmeshResiduumOutputConfig(
            *submesh_residuum_output_config_tree, output_directory, meshes);
 
        for (auto& process : processes)
        {
            auto const& residuum_vector_names =
                process->initializeAssemblyOnSubmeshes(smroc.meshes);
 
            for (auto const& name : residuum_vector_names | ranges::views::join)
            {
                smroc.output.doNotProjectFromBulkMeshToSubmeshes(
                    name, MeshLib::MeshItemType::Node);
            }
        }
 
        outputs.push_back(std::move(smroc.output));
    }
    else
    {
        // Submesh assembly must always be initialized.
        for (auto& process : processes)
        {
            process->initializeAssemblyOnSubmeshes({});
        }
    }
 
    auto per_process_data = createPerProcessData(
        config.getConfigSubtree("processes"), processes, nonlinear_solvers,
        compensate_non_equilibrium_initial_residuum, fixed_times_for_output);
 
    const bool use_staggered_scheme =
        ranges::any_of(processes.begin(), processes.end(),
                       [](auto const& process)
                       { return !(process->isMonolithicSchemeUsed()); });
 
    std::unique_ptr<NumLib::StaggeredCoupling> staggered_coupling = nullptr;
    if (use_staggered_scheme)
    {
        staggered_coupling = NumLib::createStaggeredCoupling<ProcessData>(
            config, per_process_data);
    }
    else
    {
        if (per_process_data.size() > 1)
        {
            OGS_FATAL(
                "The monolithic scheme is used. However more than one "
                "process data tags (by name \"process\") inside tag "
                "\"time_loop\" are defined for the staggered scheme. If you "
                "want to use staggered scheme, please set the element of tag "
                "\"<coupling_scheme>\" to \"staggered\".");
        }
    }
 
    const auto minmax_iter =
        std::minmax_element(per_process_data.begin(),
                            per_process_data.end(),
                            [](std::unique_ptr<ProcessData> const& a,
                               std::unique_ptr<ProcessData> const& b) {
                                return (a->timestep_algorithm->end() <
                                        b->timestep_algorithm->end());
                            });
    auto const start_time =
        per_process_data[minmax_iter.first - per_process_data.begin()]
            ->timestep_algorithm->begin();
    auto const end_time =
        per_process_data[minmax_iter.second - per_process_data.begin()]
            ->timestep_algorithm->end();
 
    return std::make_unique<TimeLoop>(
        std::move(outputs), std::move(per_process_data),
        std::move(staggered_coupling), start_time, end_time);
}

References calculateUniqueFixedTimesForAllOutputs(), createOutput(), createOutputs(), createPerProcessData(), NumLib::createStaggeredCoupling(), createSubmeshResiduumOutputConfig(), BaseLib::ConfigTree::getConfigSubtree(), BaseLib::ConfigTree::getConfigSubtreeOptional(), INFO(), MeshLib::Node, and OGS_FATAL.

Referenced by ProjectData::parseTimeLoop().

createVariableDependentNeumannBoundaryCondition()

std::unique_ptr< VariableDependentNeumannBoundaryCondition > ProcessLib::createVariableDependentNeumannBoundaryCondition	(	VariableDependentNeumannConfig const &	coefficients,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		int const	variable_id,
		int const	component_id,
		unsigned const	integration_order,
		unsigned const	shapefunction_order,
		unsigned const	global_dim,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters )

Definition at line 40 of file VariableDependentNeumannBoundaryCondition.cpp.

{
    DBUG("Constructing VariableDependentNeumann BC.");
    if (dof_table.getNumberOfVariables() != 2)
    {
        OGS_FATAL(
            "VariableDependentNeumann BC only implemented for 2 variable "
            "processes.");
    }
    assert(variable_id == 0 || variable_id == 1);
 
    if (bc_mesh.getDimension() + 1 != global_dim)
    {
        OGS_FATAL(
            "The dimension ({:d}) of the given boundary mesh '{:s}' is not by "
            "one lower than the bulk dimension ({:d}).",
            bc_mesh.getDimension(), bc_mesh.getName(), global_dim);
    }
 
    auto const& constant = ParameterLib::findParameter<double>(
        coefficients.constant_name, parameters, 1, &bc_mesh);
 
    auto const& coefficient_current_variable =
        ParameterLib::findParameter<double>(coefficients.current_variable_name,
                                            parameters, 1, &bc_mesh);
 
    auto const& coefficient_other_variable =
        ParameterLib::findParameter<double>(coefficients.other_variable_name,
                                            parameters, 1, &bc_mesh);
 
    auto const& coefficient_mixed_variables =
        ParameterLib::findParameter<double>(coefficients.mixed_variables_name,
                                            parameters, 1, &bc_mesh);
 
    std::vector<MeshLib::Node*> const& bc_nodes = bc_mesh.getNodes();
    MeshLib::MeshSubset bc_mesh_subset(bc_mesh, bc_nodes);
    auto dof_table_boundary_other_variable =
        dof_table.deriveBoundaryConstrainedMap(
            (variable_id + 1) % 2, {component_id}, std::move(bc_mesh_subset));
 
    // In case of partitioned mesh the boundary could be empty, i.e. there is no
    // boundary condition.
#ifdef USE_PETSC
    // This can be extracted to createBoundaryCondition() but then the config
    // parameters are not read and will cause an error.
    // TODO (naumov): Add a function to ConfigTree for skipping the tags of the
    // subtree and move the code up in createBoundaryCondition().
    if (bc_mesh.getDimension() == 0 && bc_mesh.getNumberOfNodes() == 0 &&
        bc_mesh.getNumberOfElements() == 0)
    {
        return nullptr;
    }
#endif  // USE_PETSC
 
    return std::make_unique<VariableDependentNeumannBoundaryCondition>(
        integration_order, shapefunction_order, dof_table, variable_id,
        component_id, global_dim, bc_mesh,
        VariableDependentNeumannBoundaryConditionData{
            constant, coefficient_current_variable, coefficient_other_variable,
            coefficient_mixed_variables,
            std::move(dof_table_boundary_other_variable)});
}

References ProcessLib::VariableDependentNeumannConfig::constant_name, ProcessLib::VariableDependentNeumannConfig::current_variable_name, DBUG(), NumLib::LocalToGlobalIndexMap::deriveBoundaryConstrainedMap(), ParameterLib::findParameter(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getName(), MeshLib::Mesh::getNodes(), MeshLib::Mesh::getNumberOfElements(), MeshLib::Mesh::getNumberOfNodes(), NumLib::LocalToGlobalIndexMap::getNumberOfVariables(), ProcessLib::VariableDependentNeumannConfig::mixed_variables_name, OGS_FATAL, and ProcessLib::VariableDependentNeumannConfig::other_variable_name.

Referenced by createBoundaryCondition().

createVolumetricSourceTerm()

std::unique_ptr< SourceTerm > ProcessLib::createVolumetricSourceTerm	(	BaseLib::ConfigTree const &	config,
		unsigned const	bulk_mesh_dimension,
		MeshLib::Mesh const &	source_term_mesh,
		std::unique_ptr< NumLib::LocalToGlobalIndexMap >	source_term_dof_table,
		std::vector< std::unique_ptr< ParameterLib::ParameterBase > > const &	parameters,
		unsigned const	integration_order,
		unsigned const	shapefunction_order )

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__type

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__type

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__type

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__Volumetric__parameter

Input File Parameter

prj__process_variables__process_variable__source_terms__source_term__Line__parameter

Definition at line 15 of file CreateVolumetricSourceTerm.cpp.

{
    auto const type = config.peekConfigParameter<std::string>("type");
    if (type == "Line")
    {
        config.checkConfigParameter("type", "Line");
        DBUG("Constructing LineSourceTerm from config.");
    }
    else
    {
        config.checkConfigParameter("type", "Volumetric");
        DBUG("Constructing VolumetricSourceTerm from config.");
    }
 
    // source term field name
    auto const& volumetric_source_term_parameter_name =
        config.getConfigParameter<std::string>("parameter");
    auto& volumetric_source_term = ParameterLib::findParameter<double>(
        volumetric_source_term_parameter_name, parameters, 1,
        &source_term_mesh);
 
    // instruction to create documentation for the parameter
 
    DBUG("Using '{:s}' as volumetric source term parameter.",
         volumetric_source_term.name);
 
    return std::make_unique<VolumetricSourceTerm>(
        bulk_mesh_dimension, source_term_mesh, std::move(source_term_dof_table),
        integration_order, shapefunction_order, volumetric_source_term);
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), ParameterLib::findParameter(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

Referenced by createSourceTerm().

createWellboreCompensateNeumannBoundaryCondition()

std::unique_ptr< WellboreCompensateNeumannBoundaryCondition > ProcessLib::createWellboreCompensateNeumannBoundaryCondition	(	WellboreCompensateCoefficients const &	coefficients,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table,
		int const	variable_id,
		int const	component_id,
		unsigned const	integration_order,
		unsigned const	shapefunction_order,
		unsigned const	global_dim,
		std::map< int, std::shared_ptr< MaterialPropertyLib::Medium > > const &	media )

Definition at line 34 of file WellboreCompensateNeumannBoundaryCondition.cpp.

{
    DBUG("Constructing WellboreCompensateNeumann BC.");
 
    if (dof_table.getNumberOfVariables() != 3)
    {
        OGS_FATAL(
            "WellboreCompensateNeumann BC only implemented for the "
            "WellboreSimulator processes.");
    }
    assert(variable_id == 0 || variable_id == 1 || variable_id == 2);
 
    if (bc_mesh.getDimension() + 1 != global_dim)
    {
        OGS_FATAL(
            "The dimension ({:d}) of the given boundary mesh '{:s}' is not by "
            "one "
            "lower than the bulk dimension ({:d}).",
            bc_mesh.getDimension(), bc_mesh.getName(), global_dim);
    }
 
    auto const pressure_id = 0;
    auto const velocity_id = 1;
    auto const enthalpy_id = 2;
 
    std::vector<MeshLib::Node*> const& bc_nodes = bc_mesh.getNodes();
    MeshLib::MeshSubset bc_mesh_subset(bc_mesh, bc_nodes);
    auto dof_table_boundary_pressure = dof_table.deriveBoundaryConstrainedMap(
        pressure_id, {component_id}, std::move(bc_mesh_subset));
    auto dof_table_boundary_velocity = dof_table.deriveBoundaryConstrainedMap(
        velocity_id, {component_id}, std::move(bc_mesh_subset));
    auto dof_table_boundary_enthalpy = dof_table.deriveBoundaryConstrainedMap(
        enthalpy_id, {component_id}, std::move(bc_mesh_subset));
 
    //
    // maybe the boundary mesh needs material ids
    auto media_map = MaterialPropertyLib::createMaterialSpatialDistributionMap(
        media, bc_mesh);
 
    return std::make_unique<WellboreCompensateNeumannBoundaryCondition>(
        integration_order, shapefunction_order, dof_table, variable_id,
        component_id, global_dim, bc_mesh,
        WellboreCompensateNeumannBoundaryConditionData{
            coefficients, std::move(dof_table_boundary_pressure),
            std::move(dof_table_boundary_velocity),
            std::move(dof_table_boundary_enthalpy), std::move(media_map)});
}

References MaterialPropertyLib::createMaterialSpatialDistributionMap(), DBUG(), NumLib::LocalToGlobalIndexMap::deriveBoundaryConstrainedMap(), MeshLib::Mesh::getDimension(), MeshLib::Mesh::getName(), MeshLib::Mesh::getNodes(), NumLib::LocalToGlobalIndexMap::getNumberOfVariables(), and OGS_FATAL.

Referenced by createBoundaryCondition().

extractElementsAlongOuterNodes()

std::vector< std::vector< std::size_t > > ProcessLib::extractElementsAlongOuterNodes ( MeshLib::Mesh const & mesh, MeshLib::Mesh const & sub_mesh, std::vector< std::size_t > const & outer_nodes )

static

Definition at line 64 of file CreateDeactivatedSubdomain.cpp.

{
    auto const& bulk_node_ids =
        *sub_mesh.getProperties().template getPropertyVector<std::size_t>(
            MeshLib::getBulkIDString(MeshLib::MeshItemType::Node),
            MeshLib::MeshItemType::Node, 1);
 
    auto to_bulk_node_id =
        ranges::views::transform([&bulk_node_ids](std::size_t const node_id)
                                 { return bulk_node_ids[node_id]; });
    auto connected_elements = ranges::views::transform(
        [&mesh](std::size_t const node_id)
        {
            return mesh.getElementsConnectedToNode(node_id) |
                   MeshLib::views::ids | ranges::to<std::vector>;
        });
 
    return outer_nodes | to_bulk_node_id | connected_elements |
           ranges::to<std::vector>;
}

References MeshLib::getBulkIDString(), MeshLib::Mesh::getElementsConnectedToNode(), MeshLib::Mesh::getProperties(), MeshLib::views::ids, and MeshLib::Node.

Referenced by createDeactivatedSubdomainMesh().

extractInnerAndOuterNodes()

template<typename IsActive>

std::pair< std::vector< std::size_t >, std::vector< std::size_t > > ProcessLib::extractInnerAndOuterNodes ( MeshLib::Mesh const & mesh, MeshLib::Mesh const & sub_mesh, IsActive is_active )

static

Definition at line 27 of file CreateDeactivatedSubdomain.cpp.

{
    auto* const bulk_node_ids = MeshLib::bulkNodeIDs(sub_mesh);
    if (bulk_node_ids == nullptr)
    {
        OGS_FATAL(
            "Bulk node ids map is not available in the deactivate subdomain "
            "mesh.");
    }
 
    std::vector<std::size_t> inner_nodes;
    // Reserve for more than needed, but not much, because almost all nodes will
    // be the inner nodes.
    inner_nodes.reserve(sub_mesh.getNumberOfNodes());
 
    std::vector<std::size_t> outer_nodes;
 
    ranges::partition_copy(
        sub_mesh.getNodes() | MeshLib::views::ids,
        back_inserter(inner_nodes),
        back_inserter(outer_nodes),
        [&](std::size_t const n)
        {
            auto const bulk_node = mesh.getNode((*bulk_node_ids)[n]);
            const auto& connected_elements =
                mesh.getElementsConnectedToNode(*bulk_node);
            // Check whether this node is connected only to an active
            // elements. Then it is an inner node, and outer otherwise.
            return ranges::all_of(connected_elements | MeshLib::views::ids,
                                  is_active);
        });
 
    return {std::move(inner_nodes), std::move(outer_nodes)};
}

References MeshLib::bulkNodeIDs(), MeshLib::Mesh::getElementsConnectedToNode(), MeshLib::Mesh::getNode(), MeshLib::Mesh::getNodes(), MeshLib::Mesh::getNumberOfNodes(), MeshLib::views::ids, and OGS_FATAL.

Referenced by createDeactivatedSubdomainMesh().

findProcessVariable()

ProcessVariable & ProcessLib::findProcessVariable	(	std::vector< ProcessVariable > const &	variables,
		BaseLib::ConfigTree const &	pv_config,
		std::string const &	tag )

Input File Parameter

special OGS input file parameter

Definition at line 40 of file ProcessUtils.cpp.

{
    // Find process variable name in process config.
    std::string const name = pv_config.getConfigParameter<std::string>(tag);
    return findVariableByName(variables, name, tag);
}

References BaseLib::ConfigTree::getConfigParameter().

findProcessVariables() [1/2]

std::vector< std::reference_wrapper< ProcessVariable > > ProcessLib::findProcessVariables	(	std::vector< ProcessVariable > const &	variables,
		BaseLib::ConfigTree const &	pv_config,
		std::initializer_list< std::string >	tags )

Find process variables in variables whose names match the settings under the given tag_names in the process_config.

In the process config a process variable is referenced by a name. For example it will be looking for a variable named "H" in the list of process variables when the tag is "hydraulic_head":

<process>
    ...
    <process_variables>
        <hydraulic_head>H</hydraulic_head>
        ...
    </process_variables>
    ...
</process>

Returns

a vector of references to the found variable(s).

Definition at line 50 of file ProcessUtils.cpp.

{
    std::vector<std::reference_wrapper<ProcessVariable>> vars;
    vars.reserve(variables.size());
 
    if (variables.size() > tags.size())
        DBUG("Found multiple process variables with a same tag.");
 
    for (auto const& tag : tags)
    {
        auto vars_per_tag = findProcessVariables(variables, pv_config, tag);
        vars.insert(vars.end(), vars_per_tag.begin(), vars_per_tag.end());
    }
 
    return vars;
}

References DBUG(), and findProcessVariables().

Referenced by ProcessLib::ComponentTransport::createComponentTransportProcess(), ProcessLib::HeatConduction::createHeatConductionProcess(), ProcessLib::HMPhaseField::createHMPhaseFieldProcess(), ProcessLib::HT::createHTProcess(), ProcessLib::HydroMechanics::createHydroMechanicsProcess(), ProcessLib::LargeDeformation::createLargeDeformationProcess(), ProcessLib::LiquidFlow::createLiquidFlowProcess(), ProcessLib::PhaseField::createPhaseFieldProcess(), ProcessLib::RichardsComponentTransport::createRichardsComponentTransportProcess(), ProcessLib::RichardsFlow::createRichardsFlowProcess(), ProcessLib::RichardsMechanics::createRichardsMechanicsProcess(), ProcessLib::SmallDeformation::createSmallDeformationProcess(), ProcessLib::SteadyStateDiffusion::createSteadyStateDiffusion(), ProcessLib::TH2M::createTH2MProcess(), ProcessLib::ThermalTwoPhaseFlowWithPP::createThermalTwoPhaseFlowWithPPProcess(), ProcessLib::ThermoHydroMechanics::createThermoHydroMechanicsProcess(), ProcessLib::ThermoMechanics::createThermoMechanicsProcess(), ProcessLib::ThermoRichardsFlow::createThermoRichardsFlowProcess(), ProcessLib::ThermoRichardsMechanics::createThermoRichardsMechanicsProcessStage2(), ProcessLib::TwoPhaseFlowWithPP::createTwoPhaseFlowWithPPProcess(), ProcessLib::WellboreSimulator::createWellboreSimulatorProcess(), and findProcessVariables().

findProcessVariables() [2/2]

std::vector< std::reference_wrapper< ProcessVariable > > ProcessLib::findProcessVariables	(	std::vector< ProcessVariable > const &	variables,
		BaseLib::ConfigTree const &	pv_config,
		std::string const &	tag,
		bool const	optional )

Input File Parameter

special OGS input file parameter

Definition at line 71 of file ProcessUtils.cpp.

{
    auto var_names = pv_config.getConfigParameterList<std::string>(tag);
 
    if (var_names.empty())
    {
        if (optional)
        {
            return {};
        }
        OGS_FATAL("No entity is found with config tag <{:s}>.", tag);
    }
 
    std::vector<std::reference_wrapper<ProcessVariable>> vars;
    std::vector<std::string> cached_var_names;
 
    for (std::string const& var_name : var_names)
    {
        vars.emplace_back(findVariableByName(variables, var_name, tag));
        cached_var_names.push_back(var_name);
    }
 
    // Eliminate duplicates in the set of variable names
    BaseLib::makeVectorUnique(cached_var_names);
 
    if (cached_var_names.size() != var_names.size())
    {
        OGS_FATAL("Found duplicates with config tag <{:s}>.", tag);
    }
 
    return vars;
}

References BaseLib::ConfigTree::getConfigParameterList(), BaseLib::makeVectorUnique(), and OGS_FATAL.

getCoupledLocalSolutions()

std::vector< double > ProcessLib::getCoupledLocalSolutions	(	std::vector< GlobalVector * > const &	global_solutions,
		std::vector< std::vector< GlobalIndexType > > const &	indices )

Fetch the nodal solutions of all coupled processes from the given vector of global solutions for each process into a flat vector.

Definition at line 12 of file CoupledSolutionsForStaggeredScheme.cpp.

{
    if (global_solutions.empty())
    {
        return {};
    }
 
    std::size_t const local_solutions_size =
        std::accumulate(cbegin(indices),
                        cend(indices),
                        std::size_t(0),
                        [](GlobalIndexType const size,
                           std::vector<GlobalIndexType> const& process_indices)
                        { return size + process_indices.size(); });
    std::vector<double> local_solutions;
    local_solutions.reserve(local_solutions_size);
 
    int number_of_processes = static_cast<int>(global_solutions.size());
    for (int process_id = 0; process_id < number_of_processes; ++process_id)
    {
        auto values = global_solutions[process_id]->get(indices[process_id]);
        local_solutions.insert(cend(local_solutions),
                               std::make_move_iterator(begin(values)),
                               std::make_move_iterator(end(values)));
    }
    return local_solutions;
}

Referenced by ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::approximateFractureWidth(), ProcessLib::VectorMatrixAssembler::assemble(), anonymous_namespace{ParallelVectorMatrixAssembler.cpp}::assembleForStaggeredSchemeOneElement(), ProcessLib::VectorMatrixAssembler::assembleWithJacobian(), anonymous_namespace{ParallelVectorMatrixAssembler.cpp}::assembleWithJacobianForStaggeredSchemeOneElement(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::computeCrackIntegral(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::computeEnergy(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::computeEnergy(), ProcessLib::ComponentTransport::ComponentTransportProcess::getFlux(), ProcessLib::HT::HTProcess::getFlux(), and ProcessLib::HT::StaggeredHTFEM< ShapeFunction, GlobalDim >::getIntPtDarcyVelocity().

getEssentialBCValuesLocal() [1/2]

void ProcessLib::getEssentialBCValuesLocal	(	ParameterLib::Parameter< double > const &	parameter,
		MeshLib::Mesh const &	bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_boundary,
		int const	variable_id,
		int const	component_id,
		const double	t,
		GlobalVector const &	x,
		NumLib::IndexValueVector< GlobalIndexType > &	bc_values )

Definition at line 104 of file DirichletBoundaryConditionAuxiliaryFunctions.cpp.

{
    getEssentialBCValuesLocal(
        parameter, bc_mesh,
        bc_mesh.getNodes() | MeshLib::views::ids | ranges::to<std::vector>,
        dof_table_boundary, variable_id, component_id, t, x, bc_values);
}

References getEssentialBCValuesLocal(), MeshLib::Mesh::getNodes(), and MeshLib::views::ids.

getEssentialBCValuesLocal() [2/2]

void ProcessLib::getEssentialBCValuesLocal	(	ParameterLib::Parameter< double > const &	parameter,
		MeshLib::Mesh const &	bc_mesh,
		std::vector< std::size_t > const &	nodes_in_bc_mesh,
		NumLib::LocalToGlobalIndexMap const &	dof_table_boundary,
		int const	variable_id,
		int const	component_id,
		const double	t,
		GlobalVector const &	,
		NumLib::IndexValueVector< GlobalIndexType > &	bc_values )

Definition at line 60 of file DirichletBoundaryConditionAuxiliaryFunctions.cpp.

{
    ParameterLib::SpatialPosition pos;
 
    bc_values.ids.clear();
    bc_values.values.clear();
 
    // convert mesh node ids to global index for the given component
    bc_values.ids.reserve(nodes_in_bc_mesh.size());
    bc_values.values.reserve(nodes_in_bc_mesh.size());
    for (auto const node_id : nodes_in_bc_mesh)
    {
        // TODO: that might be slow, but only done once
        auto const global_index = dof_table_boundary.getGlobalIndex(
            {bc_mesh.getID(), MeshLib::MeshItemType::Node, node_id},
            variable_id, component_id);
        if (global_index == NumLib::MeshComponentMap::nop)
        {
            continue;
        }
        // For the DDC approach (e.g. with PETSc option), the negative
        // index of global_index means that the entry by that index is a ghost
        // one, which should be dropped. Especially for PETSc routines
        // MatZeroRows and MatZeroRowsColumns, which are called to apply the
        // Dirichlet BC, the negative index is not accepted like other matrix or
        // vector PETSc routines. Therefore, the following if-condition is
        // applied.
        if (global_index >= 0)
        {
            pos.setNodeID(node_id);
            pos.setCoordinates(*bc_mesh.getNode(node_id));
            bc_values.ids.emplace_back(global_index);
            bc_values.values.emplace_back(parameter(t, pos).front());
        }
    }
}

References NumLib::LocalToGlobalIndexMap::getGlobalIndex(), MeshLib::Mesh::getID(), MeshLib::Mesh::getNode(), NumLib::IndexValueVector< IndexType >::ids, MeshLib::Node, NumLib::MeshComponentMap::nop, ParameterLib::SpatialPosition::setCoordinates(), ParameterLib::SpatialPosition::setNodeID(), and NumLib::IndexValueVector< IndexType >::values.

Referenced by ProcessLib::DeactivatedSubdomainDirichlet::getEssentialBCValues(), ProcessLib::DirichletBoundaryCondition::getEssentialBCValues(), ProcessLib::DirichletBoundaryConditionWithinTimeInterval::getEssentialBCValues(), ProcessLib::SolutionDependentDirichletBoundaryCondition::getEssentialBCValues(), and getEssentialBCValuesLocal().

getIntegrationPointDataMaterialStateVariables()

template<typename IntegrationPointDataVector, typename MemberType, typename MaterialStateVariables>

std::vector< double > ProcessLib::getIntegrationPointDataMaterialStateVariables	(	IntegrationPointDataVector const &	ip_data_vector,
		MemberType	member,
		std::function< std::span< double >(MaterialStateVariables &)>	get_values_span,
		int const	n_components )

Definition at line 239 of file SetOrGetIntegrationPointData.h.

{
    std::vector<double> result;
    result.reserve(ip_data_vector.size() * n_components);
 
    for (auto& ip_data : ip_data_vector)
    {
        auto const values_span = get_values_span(*(ip_data.*member));
        assert(values_span.size() == static_cast<std::size_t>(n_components));
 
        result.insert(end(result), values_span.begin(), values_span.end());
    }
 
    return result;
}

Referenced by ProcessLib::LargeDeformation::LargeDeformationLocalAssemblerInterface< DisplacementDim >::getMaterialStateVariableInternalState(), ProcessLib::RichardsMechanics::LocalAssemblerInterface< DisplacementDim >::getMaterialStateVariableInternalState(), ProcessLib::SmallDeformation::SmallDeformationLocalAssemblerInterface< DisplacementDim >::getMaterialStateVariableInternalState(), ProcessLib::TH2M::LocalAssemblerInterface< DisplacementDim >::getMaterialStateVariableInternalState(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getMaterialStateVariableInternalState(), and ProcessLib::ThermoRichardsMechanics::LocalAssemblerInterface< DisplacementDim, ConstitutiveTraits >::getMaterialStateVariableInternalState().

getIntegrationPointDimMatrixData() [1/2]

template<int DisplacementDim, typename IntegrationPointDataVector, typename Accessor>

std::vector< double > const & ProcessLib::getIntegrationPointDimMatrixData	(	IntegrationPointDataVector const &	ip_data_vector,
		Accessor &&	accessor,
		std::vector< double > &	cache )

Definition at line 31 of file SetOrGetIntegrationPointData.h.

{
    using AccessorResult = decltype(std::declval<Accessor>()(
        std::declval<IntegrationPointDataVector>()[0]));
    static_assert(std::is_lvalue_reference_v<AccessorResult>,
                  "The ip data accessor should return a reference. This check "
                  "prevents accidental copies.");
 
    auto const n_integration_points = ip_data_vector.size();
    constexpr int size = DisplacementDim * DisplacementDim;
 
    cache.clear();
    auto cache_mat = MathLib::createZeroedMatrix<
        Eigen::Matrix<double, size, Eigen::Dynamic, Eigen::RowMajor>>(
        cache, size, n_integration_points);
 
    for (unsigned ip = 0; ip < n_integration_points; ++ip)
    {
        auto const& dim_matix = accessor(ip_data_vector[ip]);
        cache_mat.col(ip) = dim_matix.template reshaped<Eigen::RowMajor>();
    }
 
    return cache;
}

References MathLib::createZeroedMatrix().

getIntegrationPointDimMatrixData() [2/2]

template<int DisplacementDim, typename IntegrationPointDataVector, typename IpData, typename MemberType>

std::vector< double > const & ProcessLib::getIntegrationPointDimMatrixData	(	IntegrationPointDataVector const &	ip_data_vector,
		MemberType IpData::*const	member,
		std::vector< double > &	cache )

Definition at line 18 of file SetOrGetIntegrationPointData.h.

{
    return getIntegrationPointDimMatrixData<DisplacementDim>(
        ip_data_vector,
        [member](IpData const& ip_data) -> auto const&
        { return ip_data.*member; },
        cache);
}

References getIntegrationPointDimMatrixData().

Referenced by getIntegrationPointDimMatrixData().

getIntegrationPointKelvinVectorData() [1/3]

template<int DisplacementDim, typename IntegrationPointDataVector, typename Accessor>

std::vector< double > const & ProcessLib::getIntegrationPointKelvinVectorData	(	IntegrationPointDataVector const &	ip_data_vector,
		Accessor &&	accessor,
		std::vector< double > &	cache )

Definition at line 73 of file SetOrGetIntegrationPointData.h.

{
    using AccessorResult = decltype(std::declval<Accessor>()(
        std::declval<IntegrationPointDataVector>()[0]));
    static_assert(std::is_lvalue_reference_v<AccessorResult>,
                  "The ip data accessor should return a reference. This check "
                  "prevents accidental copies.");
 
    constexpr int kelvin_vector_size =
        MathLib::KelvinVector::kelvin_vector_dimensions(DisplacementDim);
    auto const n_integration_points = ip_data_vector.size();
 
    cache.clear();
    auto cache_mat = MathLib::createZeroedMatrix<Eigen::Matrix<
        double, kelvin_vector_size, Eigen::Dynamic, Eigen::RowMajor>>(
        cache, kelvin_vector_size, n_integration_points);
 
    for (unsigned ip = 0; ip < n_integration_points; ++ip)
    {
        auto const& kelvin_vector = accessor(ip_data_vector[ip]);
        cache_mat.col(ip) =
            MathLib::KelvinVector::kelvinVectorToSymmetricTensor(kelvin_vector);
    }
 
    return cache;
}

References MathLib::createZeroedMatrix(), MathLib::KelvinVector::kelvin_vector_dimensions(), and MathLib::KelvinVector::kelvinVectorToSymmetricTensor().

getIntegrationPointKelvinVectorData() [2/3]

template<int DisplacementDim, typename IntegrationPointDataVector, typename IpData, typename MemberType>

std::vector< double > const & ProcessLib::getIntegrationPointKelvinVectorData	(	IntegrationPointDataVector const &	ip_data_vector,
		MemberType IpData::*const	member,
		std::vector< double > &	cache )

Definition at line 60 of file SetOrGetIntegrationPointData.h.

{
    return getIntegrationPointKelvinVectorData<DisplacementDim>(
        ip_data_vector,
        [member](IpData const& ip_data) -> auto const&
        { return ip_data.*member; },
        cache);
}

References getIntegrationPointKelvinVectorData().

Referenced by getIntegrationPointKelvinVectorData(), getIntegrationPointKelvinVectorData(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtEpsilon(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtEpsilon(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtEpsilon(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerMatrix< ShapeFunction, DisplacementDim >::getIntPtEpsilon(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerMatrixNearFracture< ShapeFunction, DisplacementDim >::getIntPtEpsilon(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtEpsilon(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtEpsilon(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtEpsilon(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtEpsilon0(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtEpsilonM(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtEpsilonMechanical(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtEpsilonTensile(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtSigma(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtSigma(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtSigma(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerMatrix< ShapeFunction, DisplacementDim >::getIntPtSigma(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerMatrixNearFracture< ShapeFunction, DisplacementDim >::getIntPtSigma(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtSigma(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtSigma(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtSigma(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtSigmaCompressive(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtSigmaIce(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtSigmaTensile(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getSigma(), and ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getSigma().

getIntegrationPointKelvinVectorData() [3/3]

template<int DisplacementDim, typename IntegrationPointDataVector, typename MemberType>

std::vector< double > ProcessLib::getIntegrationPointKelvinVectorData	(	IntegrationPointDataVector const &	ip_data_vector,
		MemberType	member )

Overload without cache argument.

Note

This function returns the data in transposed storage order compared to the overloads that have a cache argument.

Definition at line 108 of file SetOrGetIntegrationPointData.h.

{
    constexpr int kelvin_vector_size =
        MathLib::KelvinVector::kelvin_vector_dimensions(DisplacementDim);
 
    return transposeInPlace<kelvin_vector_size>(
        [&](std::vector<double>& values)
        {
            return getIntegrationPointKelvinVectorData<DisplacementDim>(
                ip_data_vector, member, values);
            ;
        });
}

References getIntegrationPointKelvinVectorData(), MathLib::KelvinVector::kelvin_vector_dimensions(), and transposeInPlace().

getIntegrationPointScalarData() [1/2]

template<typename IntegrationPointDataVector, typename Accessor>

std::vector< double > const & ProcessLib::getIntegrationPointScalarData	(	IntegrationPointDataVector const &	ip_data_vector,
		Accessor &&	accessor,
		std::vector< double > &	cache )

Definition at line 180 of file SetOrGetIntegrationPointData.h.

{
    using AccessorResult = decltype(std::declval<Accessor>()(
        std::declval<IntegrationPointDataVector>()[0]));
    static_assert(std::is_lvalue_reference_v<AccessorResult>,
                  "The ip data accessor should return a reference. This check "
                  "prevents accidental copies.");
 
    auto const n_integration_points = ip_data_vector.size();
 
    cache.clear();
    auto cache_mat = MathLib::createZeroedMatrix<
        Eigen::Matrix<double, 1, Eigen::Dynamic, Eigen::RowMajor>>(
        cache, 1, n_integration_points);
 
    for (unsigned ip = 0; ip < n_integration_points; ++ip)
    {
        cache_mat[ip] = accessor(ip_data_vector[ip]);
    }
 
    return cache;
}

References MathLib::createZeroedMatrix().

getIntegrationPointScalarData() [2/2]

template<typename IntegrationPointDataVector, typename IpData, typename MemberType>

std::vector< double > const & ProcessLib::getIntegrationPointScalarData	(	IntegrationPointDataVector const &	ip_data_vector,
		MemberType IpData::*const	member,
		std::vector< double > &	cache )

Definition at line 168 of file SetOrGetIntegrationPointData.h.

{
    return getIntegrationPointScalarData(
        ip_data_vector,
        [member](IpData const& ip_data) -> auto const&
        { return ip_data.*member; },
        cache);
}

References getIntegrationPointScalarData().

Referenced by getIntegrationPointScalarData(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::getIntPtDryDensitySolid(), ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::getIntPtDryness(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtFluidDensity(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerFracture< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtFractureAperture(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerFracture< ShapeFunction, DisplacementDim >::getIntPtFractureAperture(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerFracture< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtFracturePermeability(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtIceVolume(), ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::getIntPtLiquidMassFlowRate(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::getIntPtPorosity(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::getIntPtSaturation(), ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::getIntPtTemperature(), ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::getIntPtVaporMassFlowRate(), ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::getIntPtVaporVolumeFraction(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtViscosity(), and ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::getIntPtWidth().

makeExtrapolator()

template<typename LocalAssemblerCollection>

SecondaryVariableFunctions ProcessLib::makeExtrapolator	(	const unsigned	num_components,
		NumLib::Extrapolator &	extrapolator,
		LocalAssemblerCollection const &	local_assemblers,
		typename NumLib::ExtrapolatableLocalAssemblerCollection< LocalAssemblerCollection >::IntegrationPointValuesMethod	integration_point_values_method )

Creates an object that computes a secondary variable via extrapolation of integration point values.

Parameters

num_components	The number of components of the secondary variable.
extrapolator	The extrapolator used for extrapolation.
local_assemblers	The collection of local assemblers whose integration point values will be extrapolated.
integration_point_values_method	The member function of the local assembler returning/computing the integration point values of the specific property being extrapolated.

Definition at line 157 of file SecondaryVariable.h.

{
    auto const eval_field =
        [num_components, &extrapolator, &local_assemblers,
         integration_point_values_method](
            const double t,
            std::vector<GlobalVector*> const& x,
            std::vector<NumLib::LocalToGlobalIndexMap const*> const& dof_tables,
            std::unique_ptr<GlobalVector>& /*result_cache*/
            ) -> GlobalVector const&
    {
        auto const extrapolatables = NumLib::makeExtrapolatable(
            local_assemblers, integration_point_values_method);
        extrapolator.extrapolate(num_components, extrapolatables, t, x,
                                 dof_tables);
        return extrapolator.getNodalValues();
    };
 
    auto const eval_residuals =
        [num_components, &extrapolator, &local_assemblers,
         integration_point_values_method](
            const double t,
            std::vector<GlobalVector*> const& x,
            std::vector<NumLib::LocalToGlobalIndexMap const*> const& dof_tables,
            std::unique_ptr<GlobalVector>& /*result_cache*/
            ) -> GlobalVector const&
    {
        auto const extrapolatables = NumLib::makeExtrapolatable(
            local_assemblers, integration_point_values_method);
        extrapolator.calculateResiduals(num_components, extrapolatables, t, x,
                                        dof_tables);
        return extrapolator.getElementResiduals();
    };
    return {num_components, eval_field, eval_residuals};
}

References NumLib::Extrapolator::calculateResiduals(), NumLib::Extrapolator::extrapolate(), NumLib::Extrapolator::getElementResiduals(), NumLib::Extrapolator::getNodalValues(), and NumLib::makeExtrapolatable().

Referenced by ProcessLib::ComponentTransport::ComponentTransportProcess::initializeConcreteProcess(), ProcessLib::HeatConduction::HeatConductionProcess::initializeConcreteProcess(), ProcessLib::HMPhaseField::HMPhaseFieldProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::HT::HTProcess::initializeConcreteProcess(), ProcessLib::HydroMechanics::HydroMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::LargeDeformation::LargeDeformationProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::LIE::HydroMechanics::HydroMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::LIE::SmallDeformation::SmallDeformationProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::LiquidFlow::LiquidFlowProcess::initializeConcreteProcess(), ProcessLib::PhaseField::PhaseFieldProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::RichardsComponentTransport::RichardsComponentTransportProcess::initializeConcreteProcess(), ProcessLib::RichardsFlow::RichardsFlowProcess::initializeConcreteProcess(), ProcessLib::RichardsMechanics::RichardsMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::SmallDeformation::SmallDeformationProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::SteadyStateDiffusion::SteadyStateDiffusion::initializeConcreteProcess(), ProcessLib::TH2M::TH2MProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::ThermalTwoPhaseFlowWithPP::ThermalTwoPhaseFlowWithPPProcess::initializeConcreteProcess(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::ThermoMechanics::ThermoMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowProcess::initializeConcreteProcess(), ProcessLib::ThermoRichardsMechanics::ThermoRichardsMechanicsProcess< DisplacementDim, ConstitutiveTraits >::initializeConcreteProcess(), ProcessLib::TwoPhaseFlowWithPP::TwoPhaseFlowWithPPProcess::initializeConcreteProcess(), ProcessLib::WellboreSimulator::WellboreSimulatorProcess::initializeConcreteProcess(), and makeExtrapolator2().

makeExtrapolator2()

template<typename LocalAssemblerCollection, typename IPDataAccessor>

SecondaryVariableFunctions ProcessLib::makeExtrapolator2	(	const unsigned	num_components,
		NumLib::Extrapolator &	extrapolator,
		LocalAssemblerCollection const &	local_assemblers,
		IPDataAccessor &&	accessor )

A variant that takes an accessor function as a callback.

The accessor must take a local assembler by const reference as its only argument and must return a std::vector<double> of integration point data. The data returned by the accessor must be in "integration point writer order", which is transposed compared to "extrapolator order".

Definition at line 206 of file SecondaryVariable.h.

{
    using LocalAssemblerInterface = std::remove_cvref_t<
        decltype(*std::declval<LocalAssemblerCollection>()[0])>;
    static_assert(std::is_invocable_r_v<std::vector<double>, IPDataAccessor,
                                        LocalAssemblerInterface const&>);
 
    if (num_components == 1)
    {
        auto method_wrapped =
            [accessor](
                LocalAssemblerInterface const& loc_asm, const double /*t*/,
                std::vector<GlobalVector*> const& /*x*/,
                std::vector<
                    NumLib::LocalToGlobalIndexMap const*> const& /*dof_table*/,
                std::vector<double>& cache) -> std::vector<double> const&
        {
            cache = accessor(loc_asm);
            return cache;
        };
 
        return makeExtrapolator(num_components, extrapolator, local_assemblers,
                                method_wrapped);
    }
 
    auto method_wrapped =
        [accessor, num_components](
            LocalAssemblerInterface const& loc_asm, const double /*t*/,
            std::vector<GlobalVector*> const& /*x*/,
            std::vector<
                NumLib::LocalToGlobalIndexMap const*> const& /*dof_table*/,
            std::vector<double>& cache) -> std::vector<double> const&
    {
        cache = accessor(loc_asm);
        transposeInPlace(cache, cache.size() / num_components);
        return cache;
    };
 
    return makeExtrapolator(num_components, extrapolator, local_assemblers,
                            method_wrapped);
}

References makeExtrapolator(), and transposeInPlace().

Referenced by ProcessLib::Reflection::addReflectedSecondaryVariables().

makeProcessData()

std::unique_ptr< ProcessData > ProcessLib::makeProcessData ( std::unique_ptr< NumLib::TimeStepAlgorithm > && timestepper, NumLib::NonlinearSolverBase & nonlinear_solver, int const process_id, std::string process_name, Process & process, std::unique_ptr< NumLib::TimeDiscretization > && time_disc, std::unique_ptr< NumLib::ConvergenceCriterion > && conv_crit, bool const compensate_non_equilibrium_initial_residuum )

static

Definition at line 17 of file CreateProcessData.cpp.

{
    using Tag = NumLib::NonlinearSolverTag;
 
    if (auto* nonlinear_solver_picard =
            dynamic_cast<NumLib::NonlinearSolver<Tag::Picard>*>(
                &nonlinear_solver))
    {
        nonlinear_solver_picard->compensateNonEquilibriumInitialResiduum(
            compensate_non_equilibrium_initial_residuum);
        return std::make_unique<ProcessData>(
            std::move(timestepper), Tag::Picard, *nonlinear_solver_picard,
            std::move(conv_crit), std::move(time_disc), process_id,
            std::move(process_name), process);
    }
    if (auto* nonlinear_solver_newton =
            dynamic_cast<NumLib::NonlinearSolver<Tag::Newton>*>(
                &nonlinear_solver))
    {
        nonlinear_solver_newton->compensateNonEquilibriumInitialResiduum(
            compensate_non_equilibrium_initial_residuum);
        return std::make_unique<ProcessData>(
            std::move(timestepper), Tag::Newton, *nonlinear_solver_newton,
            std::move(conv_crit), std::move(time_disc), process_id,
            std::move(process_name), process);
    }
#ifdef USE_PETSC
    if (auto* nonlinear_solver_petsc =
            dynamic_cast<NumLib::PETScNonlinearSolver*>(&nonlinear_solver))
    {
        return std::make_unique<ProcessData>(
            std::move(timestepper), Tag::Newton, *nonlinear_solver_petsc,
            std::move(conv_crit), std::move(time_disc), process_id,
            std::move(process_name), process);
    }
#endif  // USE_PETSC
 
    OGS_FATAL("Encountered unknown nonlinear solver type. Aborting");
}

References OGS_FATAL.

Referenced by createPerProcessData().

nodeLocalIndices()

template<int GlobalDim>

auto ProcessLib::nodeLocalIndices

(

std::size_t const

i

)

Definition at line 27 of file EmbeddedAnchor.cpp.

{
    return Eigen::seqN(i, Eigen::fix<GlobalDim>, Eigen::fix<2>);
}

Referenced by ProcessLib::EmbeddedAnchor< GlobalDim >::getShapeMatricesAndGlobalIndicesAndDisplacements(), and ProcessLib::EmbeddedAnchor< GlobalDim >::integrate().

operator<<() [1/4]

std::ostream & ProcessLib::operator<<	(	std::ostream &	os,
		Output const &	output )

Definition at line 448 of file ProcessLib/Output/Output.cpp.

{
    os << "Output::_output_data_specification:\t"
       << output._output_data_specification;
    os << "Output::_output_format:\t" << *(output._output_format);
    return os;
}

operator<<() [2/4]

std::ostream & ProcessLib::operator<<	(	std::ostream &	os,
		OutputDataSpecification const &	o )

Definition at line 84 of file OutputDataSpecification.cpp.

{
    os << "OuputDataSpecification" << std::endl;
    os << "\toutput_variables: ";
    std::copy(o.output_variables.begin(), o.output_variables.end(),
              std::ostream_iterator<std::string>(os, " "));
    os << "\n";
    os << "\tfixed_output_times: ";
    std::copy(o.fixed_output_times.begin(), o.fixed_output_times.end(),
              std::ostream_iterator<double>(os, " "));
    os << "\n";
    os << "\trepeats_each_steps: ";
    std::copy(o.repeats_each_steps.begin(), o.repeats_each_steps.end(),
              std::ostream_iterator<PairRepeatEachSteps>(os, " "));
    os << "\n";
    os << "\toutput_residual: " << o.output_residuals << "\n";
    return os;
}

References ProcessLib::OutputDataSpecification::fixed_output_times, ProcessLib::OutputDataSpecification::output_residuals, ProcessLib::OutputDataSpecification::output_variables, and ProcessLib::OutputDataSpecification::repeats_each_steps.

operator<<() [3/4]

std::ostream & ProcessLib::operator<< ( std::ostream & os, OutputFormat const & of )

inline

Definition at line 44 of file OutputFormat.h.

{
    os << "OutputFormat::directory:" << of.directory << std::endl;
    os << "OutputFormat::prefix:" << of.prefix << std::endl;
    os << "OutputFormat::suffix:" << of.suffix << std::endl;
    os << "OutputFormat::compression:" << of.compression << std::endl;
    return os;
}

References ProcessLib::OutputFormat::compression, ProcessLib::OutputFormat::directory, ProcessLib::OutputFormat::prefix, and ProcessLib::OutputFormat::suffix.

operator<<() [4/4]

std::ostream & ProcessLib::operator<<	(	std::ostream &	os,
		PairRepeatEachSteps const &	pair )

Definition at line 77 of file OutputDataSpecification.cpp.

{
    os << "Output " << pair.repeat << " times every " << pair.each_steps
       << " timestep.\n";
    return os;
}

References ProcessLib::PairRepeatEachSteps::each_steps, and ProcessLib::PairRepeatEachSteps::repeat.

outputMeshVtk() [1/2]

void ProcessLib::outputMeshVtk	(	OutputVTKFormat const &	output_file,
		MeshLib::IO::PVDFile &	pvd_file,
		MeshLib::Mesh const &	mesh,
		double const	t,
		int const	timestep,
		int const	iteration,
		bool const	converged )

Definition at line 50 of file OutputFormat.cpp.

{
    auto const name = output_file.constructFilename(mesh.getName(), timestep, t,
                                                    iteration, converged);
    pvd_file.addVTUFile(name, t);
 
    auto const path = BaseLib::joinPaths(output_file.directory, name);
    // Output of NaN's triggers floating point exceptions. Because we are not
    // debugging VTK (or other libraries) at this point, the possibly set
    // exceptions are temporarily disabled and are restored at the end of the
    // function.
    [[maybe_unused]] DisableFPE disable_fpe;
    outputMeshVtk(path, mesh, output_file.compression, output_file.data_mode);
}

References MeshLib::IO::PVDFile::addVTUFile(), ProcessLib::OutputFormat::compression, ProcessLib::OutputVTKFormat::constructFilename(), ProcessLib::OutputVTKFormat::data_mode, ProcessLib::OutputFormat::directory, MeshLib::Mesh::getName(), BaseLib::joinPaths(), and outputMeshVtk().

outputMeshVtk() [2/2]

void ProcessLib::outputMeshVtk	(	std::string const &	file_name,
		MeshLib::Mesh const &	mesh,
		bool const	compress_output,
		int const	data_mode )

Definition at line 41 of file OutputFormat.cpp.

{
    DBUG("Writing output to '{:s}'.", file_name);
 
    MeshLib::IO::VtuInterface vtu_interface(&mesh, data_mode, compress_output);
    vtu_interface.writeToFile(file_name);
}

References DBUG(), and MeshLib::IO::VtuInterface::writeToFile().

Referenced by ProcessLib::Output::doOutputNonlinearIteration(), ProcessLib::OutputVTKFormat::outputMeshes(), and outputMeshVtk().

parseBall()

detail::Ball ProcessLib::parseBall ( BaseLib::ConfigTree const & config )

static

Returns a ball represented by its center and its radius.

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__ball__center

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__ball__radius

Definition at line 210 of file CreateDeactivatedSubdomain.cpp.

{
    DBUG("Constructing a ball");
    auto const center =
        config.getConfigParameter<std::vector<double>>("center");
    if (center.size() != 3)
    {
        OGS_FATAL(
            "For construction of the center of a ball must be a 3D point. Got "
            "a vector of size {}.",
            center.size());
    }
 
    auto const radius =
        config.getConfigParameter<double>("radius");
 
    return {Eigen::Vector3d{center[0], center[1], center[2]}, radius};
}

References DBUG(), BaseLib::ConfigTree::getConfigParameter(), and OGS_FATAL.

Referenced by createDeactivatedSubdomain().

parseConstraintDirichletBoundaryCondition()

ConstraintDirichletBoundaryConditionConfig ProcessLib::parseConstraintDirichletBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__ConstraintDirichlet__constraint_type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__ConstraintDirichlet__constraining_process_variable

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__ConstraintDirichlet__constraint_threshold

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__ConstraintDirichlet__constraint_direction

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__ConstraintDirichlet__parameter

Definition at line 217 of file ConstraintDirichletBoundaryCondition.cpp.

{
    DBUG("Parsing ConstraintDirichletBoundaryCondition from config.");
    config.checkConfigParameter("type", "ConstraintDirichlet");
 
    auto const type =
        config.getConfigParameter<std::string>("constraint_type");
 
    // Todo (TF) Open question: How to specify which getFlux function should be
    // used for the constraint calculation?
    auto const process_variable =
        config.getConfigParameter<std::string>("constraining_process_variable");
 
    auto const threshold =
        config.getConfigParameter<double>("constraint_threshold");
 
    auto const direction_string =
        config.getConfigParameter<std::string>("constraint_direction");

    auto const name = config.getConfigParameter<std::string>("parameter");
    DBUG("parameter name {:s}", name);
 
    return {type, process_variable, threshold, direction_string, name};
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and parseConstraintDirichletBoundaryCondition().

Referenced by createBoundaryCondition(), and parseConstraintDirichletBoundaryCondition().

parseDirichletBCConfig()

std::string ProcessLib::parseDirichletBCConfig

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__Dirichlet__parameter

Definition at line 49 of file DirichletBoundaryCondition.cpp.

{
    config.checkConfigParameter("type", "Dirichlet");

    auto const name = config.getConfigParameter<std::string>("parameter");
    DBUG("{}: parameter name {:s}", __FUNCTION__, name);
    return name;
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createBoundaryCondition().

parseDirichletBoundaryConditionWithinTimeIntervalConfig()

DirichletBoundaryConditionConfig ProcessLib::parseDirichletBoundaryConditionWithinTimeIntervalConfig

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__DirichletWithinTimeInterval__parameter

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__DirichletWithinTimeInterval__time_interval

Definition at line 15 of file CreateDirichletBoundaryConditionWithinTimeInterval.cpp.

{
    config.checkConfigParameter("type", "DirichletWithinTimeInterval");

    auto const name = config.getConfigParameter<std::string>("parameter");
    DBUG("{}: parameter name {:s}", __FUNCTION__, name);

    config.peekConfigParameter<std::string>("time_interval");
    auto time_interval = BaseLib::createTimeInterval(config);
 
    return {name, time_interval};
}

References BaseLib::ConfigTree::checkConfigParameter(), BaseLib::createTimeInterval(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::peekConfigParameter().

Referenced by createBoundaryCondition().

parseHCNonAdvectiveFreeComponentFlowBoundaryCondition()

std::string ProcessLib::parseHCNonAdvectiveFreeComponentFlowBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__HCNonAdvectiveFreeComponentFlowBoundary__parameter

Definition at line 11 of file HCNonAdvectiveFreeComponentFlowBoundaryCondition.cpp.

{
    DBUG("Parsing open boundary for Component Transport process.");

    config.checkConfigParameter("type",
                                "HCNonAdvectiveFreeComponentFlowBoundary");
 
    auto const boundary_permeability_name =
        config.getConfigParameter<std::string>("parameter");
 
    return boundary_permeability_name;
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createBoundaryCondition().

parseLineSegment()

std::pair< Eigen::Vector3d, Eigen::Vector3d > ProcessLib::parseLineSegment ( BaseLib::ConfigTree const & config )

static

Returns a line segment represented by its begin and end points.

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__line_segment__start

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__line_segment__end

Definition at line 179 of file CreateDeactivatedSubdomain.cpp.

{
    DBUG("Constructing line segment");
    auto const start =
        config.getConfigParameter<std::vector<double>>("start");
    if (start.size() != 3)
    {
        OGS_FATAL(
            "For construction of a line segment the start point must be a 3D "
            "point. Got a vector of size {}.",
            start.size());
    }
 
    auto const end =
        config.getConfigParameter<std::vector<double>>("end");
 
    if (end.size() != 3)
    {
        OGS_FATAL(
            "For construction of a line segment the end point must be a 3D "
            "point. Got a vector of size {}.",
            end.size());
    }
    return {Eigen::Vector3d{start[0], start[1], start[2]},
            Eigen::Vector3d{end[0], end[1], end[2]}};
}

References DBUG(), BaseLib::ConfigTree::getConfigParameter(), and OGS_FATAL.

Referenced by createDeactivatedSubdomain().

parseNeumannBoundaryCondition()

NeumannBoundaryConditionConfig ProcessLib::parseNeumannBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__Neumann__parameter

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__Neumann__area_parameter

Definition at line 10 of file NeumannBoundaryCondition.cpp.

{
    config.checkConfigParameter("type", "Neumann");

    auto const name = config.getConfigParameter<std::string>("parameter");
    DBUG("{}: parameter {:s}", __FUNCTION__, name);
 
    auto const area_parameter_name =
        config.getConfigParameterOptional<std::string>("area_parameter");
    if (area_parameter_name.has_value())
    {
        DBUG("{}: area parameter name '{:s}'", __FUNCTION__,
             area_parameter_name.value());
    }
 
    return {name, area_parameter_name};
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::getConfigParameterOptional().

Referenced by createBoundaryCondition().

parsePhaseFieldIrreversibleDamageOracleBoundaryCondition()

void ProcessLib::parsePhaseFieldIrreversibleDamageOracleBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Definition at line 63 of file PhaseFieldIrreversibleDamageOracleBoundaryCondition.cpp.

{
    DBUG("Parsing PhaseFieldIrreversibleDamageOracleBoundaryCondition.");

    config.checkConfigParameter(
        "type", "PhaseFieldIrreversibleDamageOracleBoundaryCondition");
}

References BaseLib::ConfigTree::checkConfigParameter(), and DBUG().

Referenced by createBoundaryCondition().

parsePrimaryVariableConstraintDirichletBoundaryCondition()

PrimaryVariableConstraintDirichletBoundaryConditionConfig ProcessLib::parsePrimaryVariableConstraintDirichletBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__PrimaryVariableConstraintDirichlet__parameter

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__PrimaryVariableConstraintDirichlet__threshold_parameter

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__PrimaryVariableConstraintDirichlet__comparison_operator

Definition at line 100 of file PrimaryVariableConstraintDirichletBoundaryCondition.cpp.

{
    DBUG("Parsing PrimaryVariableConstraintDirichletBoundaryCondition config.");
    config.checkConfigParameter("type", "PrimaryVariableConstraintDirichlet");

    auto const name = config.getConfigParameter<std::string>("parameter");
    DBUG("parameter {:s}", name);
 
    auto const threshold_parameter_name =
        config.getConfigParameter<std::string>("threshold_parameter");
    DBUG("parameter {:s} as threshold_parameter", threshold_parameter_name);
 
    auto const comparison_operator_string =
        config.getConfigParameter<std::string>("comparison_operator");
 
    return {name, threshold_parameter_name, comparison_operator_string};
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createBoundaryCondition().

parsePythonBoundaryCondition()

PythonBoundaryConditionConfig ProcessLib::parsePythonBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__Python__bc_object

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__Python__flush_stdout

Definition at line 262 of file PythonBoundaryCondition.cpp.

{
    config.checkConfigParameter("type", "Python");

    auto const bc_object = config.getConfigParameter<std::string>("bc_object");
    auto const flush_stdout = config.getConfigParameter("flush_stdout", false);
 
    return {bc_object, flush_stdout};
}

References BaseLib::ConfigTree::checkConfigParameter(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createBoundaryCondition().

parseReleaseNodalForce()

std::string ProcessLib::parseReleaseNodalForce

(

BoundaryConditionConfig const &

bc_config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__ReleaseNodalForce__time_decay_parameter

Definition at line 23 of file CreateReleaseNodalForce.cpp.

{
    DBUG("Parse ReleaseNodalForce boundary condition.");
 
    if (!bc_config.compensate_non_equilibrium_initial_residuum)
    {
        OGS_FATAL(
            "The compensate_non_equilibrium_initial_residuum must be set for "
            "the ReleaseNodalForce boundary condition.");
    }
 
    auto const& config = bc_config.config;
    config.checkConfigParameter("type", "ReleaseNodalForce");
 
    auto const decay_parameter_name =
        config.getConfigParameter<std::string>("time_decay_parameter");
    DBUG("decay parameter {:s}", decay_parameter_name);
 
    return decay_parameter_name;
}

References BaseLib::ConfigTree::checkConfigParameter(), ProcessLib::BoundaryConditionConfig::compensate_non_equilibrium_initial_residuum, ProcessLib::BoundaryConditionConfig::config, DBUG(), and OGS_FATAL.

Referenced by createBoundaryCondition().

parseRobinBoundaryCondition()

RobinBoundaryConditionConfig ProcessLib::parseRobinBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__Robin__alpha

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__Robin__u_0

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__Robin__area_parameter

Definition at line 10 of file RobinBoundaryCondition.cpp.

{
    DBUG("parsing RobinBoundaryConditionConfig.");
    config.checkConfigParameter("type", "Robin");

    auto const alpha_name = config.getConfigParameter<std::string>("alpha");
    auto const u_0_name = config.getConfigParameter<std::string>("u_0");
 
    auto const area_parameter_name =
        config.getConfigParameterOptional<std::string>("area_parameter");
    if (area_parameter_name.has_value())
    {
        DBUG("area parameter name '{:s}'", __FUNCTION__,
             area_parameter_name.value());
    }
 
    return {alpha_name, u_0_name, area_parameter_name};
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), BaseLib::ConfigTree::getConfigParameter(), and BaseLib::ConfigTree::getConfigParameterOptional().

Referenced by createBoundaryCondition().

parseSolutionDependentDirichletBoundaryCondition()

SolutionDependentDirichletBoundaryConditionConfig ProcessLib::parseSolutionDependentDirichletBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__SolutionDependentDirichlet__property_name

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__SolutionDependentDirichlet__initial_value_parameter

Definition at line 93 of file SolutionDependentDirichletBoundaryCondition.cpp.

{
    DBUG("Parsing SolutionDependentDirichletBoundaryCondition.");

    config.checkConfigParameter("type", "SolutionDependentDirichlet");
 
    auto property_name =
        config.getConfigParameter<std::string>("property_name");
 
    auto const initial_value_parameter_string =
        config.getConfigParameter<std::string>("initial_value_parameter");
 
    return {property_name, initial_value_parameter_string};
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createBoundaryCondition().

parseTimeDecayDirichletBoundaryConditionConfig()

TimeDecayDirichletBoundaryConditionConfig ProcessLib::parseTimeDecayDirichletBoundaryConditionConfig

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__TimeDecayDirichlet__time_decay_parameter

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__TimeDecayDirichlet__lower_limit

Definition at line 19 of file CreateTimeDecayDirichletBoundaryCondition.cpp.

{
    config.checkConfigParameter("type", "TimeDecayDirichlet");
 
    auto const parameter_name =
        config.getConfigParameter<std::string>("time_decay_parameter");
    DBUG("Using parameter {:s}", parameter_name);
 
    auto const lower_limit =
        config.getConfigParameter<double>("lower_limit");
 
    return {parameter_name, lower_limit};
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createBoundaryCondition().

parseTimeIntervalOrCurve()

MathLib::PiecewiseLinearInterpolation ProcessLib::parseTimeIntervalOrCurve ( std::optional< BaseLib::ConfigTree > const & time_interval_config, std::optional< std::string > const & curve_name, std::map< std::string, std::unique_ptr< MathLib::PiecewiseLinearInterpolation > > const & curves )

static

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__time_interval__start

Input File Parameter

prj__process_variables__process_variable__deactivated_subdomains__deactivated_subdomain__time_interval__end

Definition at line 126 of file CreateDeactivatedSubdomain.cpp.

{
    // Check for the error case first: only one of the configs must be used.
    if (time_interval_config && curve_name)
    {
        OGS_FATAL(
            "In the deactivate subdomain either a time interval or a curve "
            "must be given, not both.");
    }
 
    // Parse time interval and return a curve
    if (time_interval_config)
    {
        DBUG("Constructing time interval");
        auto const start_time =
            time_interval_config->getConfigParameter<double>("start");
 
        auto const end_time =
            time_interval_config->getConfigParameter<double>("end");
 
        // Using very large value for the curve's value, s.t. for any time from
        // start to end the whole subdomain is deactivated at once.
        return {std::vector<double>({start_time, end_time}),
                std::vector<double>({std::numeric_limits<double>::max(),
                                     std::numeric_limits<double>::max()}),
                false};
    }
 
    // Try to find the curve.
    if (curve_name)
    {
        DBUG("Using curve '{:s}'", *curve_name);
        // Return a copy of the curve because the time interval in the other
        // branch returns a temporary.
        return *BaseLib::getOrError(curves, *curve_name,
                                    "Could not find curve.");
    }
 
    // If we got so far, there is an error: one of the configs must be
    // available.
    OGS_FATAL(
        "In the deactivate subdomain neither a time interval nor a curve are "
        "given. One of them must be specified.");
}

References DBUG(), BaseLib::getOrError(), and OGS_FATAL.

Referenced by createDeactivatedSubdomain().

parseVariableDependentNeumannBoundaryCondition()

VariableDependentNeumannConfig ProcessLib::parseVariableDependentNeumannBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__VariableDependentNeumann__constant_name

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__VariableDependentNeumann__coefficient_current_variable_name

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__VariableDependentNeumann__coefficient_other_variable_name

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__VariableDependentNeumann__coefficient_mixed_variables_name

Definition at line 10 of file VariableDependentNeumannBoundaryCondition.cpp.

{
    config.checkConfigParameter("type", "VariableDependentNeumann");
 
    auto const constant_name =
        config.getConfigParameter<std::string>("constant_name");
 
    auto const coefficient_current_variable_name =
        config.getConfigParameter<std::string>(
            "coefficient_current_variable_name");
 
    auto const coefficient_other_variable_name =
        config.getConfigParameter<std::string>(
            "coefficient_other_variable_name");
 
    auto const coefficient_mixed_variables_name =
        config.getConfigParameter<std::string>(
            "coefficient_mixed_variables_name");
 
    return {constant_name, coefficient_current_variable_name,
            coefficient_other_variable_name, coefficient_mixed_variables_name};
}

References BaseLib::ConfigTree::checkConfigParameter(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createBoundaryCondition().

parseWellboreCompensateNeumannBoundaryCondition()

WellboreCompensateCoefficients ProcessLib::parseWellboreCompensateNeumannBoundaryCondition

(

BaseLib::ConfigTree const &

config

)

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__type

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__WellboreCompensateNeumann__coefficient_pressure

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__WellboreCompensateNeumann__coefficient_velocity

Input File Parameter

prj__process_variables__process_variable__boundary_conditions__boundary_condition__WellboreCompensateNeumann__coefficient_enthalpy

Definition at line 11 of file WellboreCompensateNeumannBoundaryCondition.cpp.

{
    DBUG("Parsing WellboreCompensateNeumann BC.");
    config.checkConfigParameter("type", "WellboreCompensateNeumann");
 
    auto const pressure_coefficient =
        config.getConfigParameter<double>("coefficient_pressure");
 
    auto const velocity_coefficient =
        config.getConfigParameter<double>("coefficient_velocity");
 
    auto const enthalpy_coefficient =
        config.getConfigParameter<double>("coefficient_enthalpy");
 
    return {pressure_coefficient, velocity_coefficient, enthalpy_coefficient};
}

References BaseLib::ConfigTree::checkConfigParameter(), DBUG(), and BaseLib::ConfigTree::getConfigParameter().

Referenced by createBoundaryCondition().

postTimestepForAllProcesses()

void ProcessLib::postTimestepForAllProcesses	(	NumLib::Time const &	t,
		double const	dt,
		std::vector< std::unique_ptr< ProcessData > > const &	per_process_data,
		std::vector< GlobalVector * > const &	process_solutions,
		std::vector< GlobalVector * > const &	process_solutions_prev )

Definition at line 87 of file TimeLoop.cpp.

{
    for (auto& process_data : per_process_data)
    {
        auto const process_id = process_data->process_id;
        auto& pcs = process_data->process;
 
        pcs.computeSecondaryVariable(t(), dt, process_solutions,
                                     *process_solutions_prev[process_id],
                                     process_id);
        pcs.postTimestep(process_solutions, process_solutions_prev, t(), dt,
                         process_id);
    }
}

Referenced by ProcessLib::TimeLoop::preTsNonlinearSolvePostTs().

preTimestepForAllProcesses()

void ProcessLib::preTimestepForAllProcesses	(	NumLib::Time const &	t,
		double const	dt,
		std::vector< std::unique_ptr< ProcessData > > const &	per_process_data,
		std::vector< GlobalVector * > const &	_process_solutions )

Definition at line 74 of file TimeLoop.cpp.

{
    for (auto& process_data : per_process_data)
    {
        auto const process_id = process_data->process_id;
        auto& pcs = process_data->process;
        pcs.preTimestep(_process_solutions, t(), dt, process_id);
    }
}

Referenced by ProcessLib::TimeLoop::preTsNonlinearSolvePostTs().

pythonBindBoundaryCondition()

OGS_EXPORT_SYMBOL void ProcessLib::pythonBindBoundaryCondition

(

pybind11::module &

m

)

Creates Python bindings for the Python BC class.

Definition at line 42 of file PythonBoundaryConditionModule.cpp.

{
    namespace py = pybind11;
 
    py::class_<PythonBoundaryConditionPythonSideInterface,
               PythonBoundaryConditionPythonSideInterfaceTrampoline>
        pybc(m, "BoundaryCondition");
 
    pybc.def(py::init());
 
    pybc.def("getDirichletBCValue",
             &PythonBoundaryConditionPythonSideInterface::getDirichletBCValue);
    pybc.def("getFlux", &PythonBoundaryConditionPythonSideInterface::getFlux);
}

References ProcessLib::PythonBoundaryConditionPythonSideInterface::getDirichletBCValue(), and ProcessLib::PythonBoundaryConditionPythonSideInterface::getFlux().

Referenced by PYBIND11_EMBEDDED_MODULE(), and PYBIND11_MODULE().

removeIPFieldDataNameSuffix()

std::string_view ProcessLib::removeIPFieldDataNameSuffix ( std::string_view const name )

inline

Removes the suffix '_ip' from the passed field name.

Definition at line 15 of file SetIPDataInitialConditions.h.

{
    if (!name.ends_with("_ip"))
    {
        OGS_FATAL(
            "The name of integration point data must end with '_ip'. '{}' "
            "does not.",
            name);
    }
 
    return {name.data(), name.size() - 3};
}

References OGS_FATAL.

Referenced by setIPDataInitialConditions().

setEquationSystem()

void ProcessLib::setEquationSystem

(

ProcessData const &

process_data

)

Definition at line 10 of file ProcessData.cpp.

{
    auto& conv_crit = *process_data.conv_crit;
    auto& nonlinear_solver = process_data.nonlinear_solver;
 
    using Tag = NumLib::NonlinearSolverTag;
    switch (process_data.nonlinear_solver_tag)
    {
        case Tag::Picard:
        {
            using EqSys = NumLib::NonlinearSystem<Tag::Picard>;
            auto& eq_sys_ = static_cast<EqSys&>(*process_data.tdisc_ode_sys);
            if (auto* nl_solver =
                    dynamic_cast<NumLib::NonlinearSolver<Tag::Picard>*>(
                        &nonlinear_solver);
                nl_solver != nullptr)
            {
                nl_solver->setEquationSystem(eq_sys_, conv_crit);
            }
            else
            {
                OGS_FATAL(
                    "Could not cast nonlinear solver to Picard type solver.");
            }
            break;
        }
        case Tag::Newton:
        {
            using EqSys = NumLib::NonlinearSystem<Tag::Newton>;
            auto& eq_sys_ = static_cast<EqSys&>(*process_data.tdisc_ode_sys);
 
            if (auto* nl_solver =
                    dynamic_cast<NumLib::NonlinearSolver<Tag::Newton>*>(
                        &nonlinear_solver);
                nl_solver != nullptr)
            {
                nl_solver->setEquationSystem(eq_sys_, conv_crit);
            }
#ifdef USE_PETSC
            else if (auto* nl_solver =
                         dynamic_cast<NumLib::PETScNonlinearSolver*>(
                             &nonlinear_solver);
                     nl_solver != nullptr)
            {
                nl_solver->setEquationSystem(eq_sys_, conv_crit);
            }
#endif  // USE_PETSC
            else
            {
                OGS_FATAL(
                    "Could not cast nonlinear solver to Newton type solver.");
            }
            break;
        }
    }
}

References ProcessLib::ProcessData::conv_crit, ProcessLib::ProcessData::nonlinear_solver, ProcessLib::ProcessData::nonlinear_solver_tag, OGS_FATAL, and ProcessLib::ProcessData::tdisc_ode_sys.

Referenced by calculateNonEquilibriumInitialResiduum(), and solveOneTimeStepOneProcess().

setInitialConditions()

std::pair< std::vector< GlobalVector * >, std::vector< GlobalVector * > > ProcessLib::setInitialConditions	(	NumLib::Time const &	t0,
		std::vector< std::unique_ptr< ProcessData > > const &	per_process_data )

Definition at line 166 of file TimeLoop.cpp.

{
    std::vector<GlobalVector*> process_solutions;
    std::vector<GlobalVector*> process_solutions_prev;
 
    for (auto const& process_data : per_process_data)
    {
        auto const process_id = process_data->process_id;
        auto& ode_sys = *process_data->tdisc_ode_sys;
 
        // append a solution vector of suitable size
        process_solutions.emplace_back(
            &NumLib::GlobalVectorProvider::provider.getVector(
                ode_sys.getMatrixSpecifications(process_id)));
        process_solutions_prev.emplace_back(
            &NumLib::GlobalVectorProvider::provider.getVector(
                ode_sys.getMatrixSpecifications(process_id)));
    }
 
    for (auto const& process_data : per_process_data)
    {
        auto& pcs = process_data->process;
        auto const process_id = process_data->process_id;
        pcs.setInitialConditions(process_solutions, process_solutions_prev,
                                 t0(), process_id);
 
        auto& time_disc = *process_data->time_disc;
        time_disc.setInitialState(t0());  // push IC
    }
 
    return {process_solutions, process_solutions_prev};
}

References NumLib::GlobalVectorProvider::provider.

Referenced by ProcessLib::TimeLoop::initialize().

setIntegrationPointDataMaterialStateVariables()

template<typename IntegrationPointDataVector, typename MemberType, typename MaterialStateVariables>

std::size_t ProcessLib::setIntegrationPointDataMaterialStateVariables	(	double const *	values,
		IntegrationPointDataVector &	ip_data_vector,
		MemberType	member,
		std::function< std::span< double >(MaterialStateVariables &)>	get_values_span )

Definition at line 262 of file SetOrGetIntegrationPointData.h.

{
    auto const n_integration_points = ip_data_vector.size();
 
    std::size_t position = 0;
    for (auto const& ip_data : ip_data_vector)
    {
        auto const values_span = get_values_span(*(ip_data.*member));
        std::copy_n(values + position, values_span.size(), values_span.begin());
        position += values_span.size();
    }
    return n_integration_points;
}

Referenced by ProcessLib::LargeDeformation::LargeDeformationLocalAssemblerInterface< DisplacementDim >::setIPDataInitialConditions(), ProcessLib::RichardsMechanics::LocalAssemblerInterface< DisplacementDim >::setIPDataInitialConditions(), ProcessLib::SmallDeformation::SmallDeformationLocalAssemblerInterface< DisplacementDim >::setIPDataInitialConditions(), ProcessLib::TH2M::TH2MLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setIPDataInitialConditions(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setIPDataInitialConditions(), and ProcessLib::ThermoRichardsMechanics::LocalAssemblerInterface< DisplacementDim, ConstitutiveTraits >::setIPDataInitialConditions().

setIntegrationPointKelvinVectorData() [1/2]

template<int DisplacementDim, typename IntegrationPointDataVector, typename Accessor>

std::size_t ProcessLib::setIntegrationPointKelvinVectorData	(	double const *	values,
		IntegrationPointDataVector &	ip_data_vector,
		Accessor &&	accessor )

Definition at line 137 of file SetOrGetIntegrationPointData.h.

{
    using AccessorResult = decltype(std::declval<Accessor>()(
        std::declval<IntegrationPointDataVector>()[0]));
    static_assert(std::is_lvalue_reference_v<AccessorResult>,
                  "The ip data accessor must return a reference.");
 
    constexpr int kelvin_vector_size =
        MathLib::KelvinVector::kelvin_vector_dimensions(DisplacementDim);
    auto const n_integration_points = ip_data_vector.size();
 
    auto kelvin_vector_values =
        Eigen::Map<Eigen::Matrix<double, kelvin_vector_size, Eigen::Dynamic,
                                 Eigen::ColMajor> const>(
            values, kelvin_vector_size, n_integration_points);
 
    for (unsigned ip = 0; ip < n_integration_points; ++ip)
    {
        accessor(ip_data_vector[ip]) =
            MathLib::KelvinVector::symmetricTensorToKelvinVector(
                kelvin_vector_values.col(ip));
    }
 
    return n_integration_points;
}

References MathLib::KelvinVector::kelvin_vector_dimensions(), and MathLib::KelvinVector::symmetricTensorToKelvinVector().

setIntegrationPointKelvinVectorData() [2/2]

template<int DisplacementDim, typename IntegrationPointDataVector, typename IpData, typename MemberType>

std::size_t ProcessLib::setIntegrationPointKelvinVectorData	(	double const *	values,
		IntegrationPointDataVector &	ip_data_vector,
		MemberType IpData::*const	member )

Definition at line 125 of file SetOrGetIntegrationPointData.h.

{
    return setIntegrationPointKelvinVectorData<DisplacementDim>(
        values, ip_data_vector,
        [member](IpData& ip_data) -> auto& { return ip_data.*member; });
}

References setIntegrationPointKelvinVectorData().

Referenced by ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::setEpsilon(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::setEpsilonMechanical(), setIntegrationPointKelvinVectorData(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setIPDataInitialConditions(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::setIPDataInitialConditions(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setIPDataInitialConditions(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setSigma(), and ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::setSigma().

setIntegrationPointScalarData() [1/2]

template<typename IntegrationPointDataVector, typename Accessor>

std::size_t ProcessLib::setIntegrationPointScalarData	(	double const *	values,
		IntegrationPointDataVector &	ip_data_vector,
		Accessor &&	accessor )

Definition at line 218 of file SetOrGetIntegrationPointData.h.

{
    using AccessorResult = decltype(std::declval<Accessor>()(
        std::declval<IntegrationPointDataVector>()[0]));
    static_assert(std::is_lvalue_reference_v<AccessorResult>,
                  "The ip data accessor must return a reference.");
 
    auto const n_integration_points = ip_data_vector.size();
 
    for (unsigned ip = 0; ip < n_integration_points; ++ip)
    {
        accessor(ip_data_vector[ip]) = values[ip];
    }
    return n_integration_points;
}

setIntegrationPointScalarData() [2/2]

template<typename IntegrationPointDataVector, typename IpData, typename MemberType>

std::size_t ProcessLib::setIntegrationPointScalarData	(	double const *	values,
		IntegrationPointDataVector &	ip_data_vector,
		MemberType IpData::*const	member )

Definition at line 207 of file SetOrGetIntegrationPointData.h.

{
    return setIntegrationPointScalarData(values, ip_data_vector,
                                         [member](IpData& ip_data) -> auto&
                                         { return ip_data.*member; });
}

References setIntegrationPointScalarData().

Referenced by setIntegrationPointScalarData(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setIPDataInitialConditions(), and ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowLocalAssembler< ShapeFunction, GlobalDim >::setIPDataInitialConditions().

setIPDataInitialConditions()

template<typename LocalAssemblersVector>

void ProcessLib::setIPDataInitialConditions	(	std::vector< std::unique_ptr< MeshLib::IntegrationPointWriter > > const &	_integration_point_writer,
		MeshLib::Properties const &	mesh_properties,
		LocalAssemblersVector &	local_assemblers )

Definition at line 29 of file SetIPDataInitialConditions.h.

{
    auto const& opt_ip_meta_data_all =
        MeshLib::getIntegrationPointMetaData(mesh_properties);
 
    for (auto const& ip_writer : _integration_point_writer)
    {
        // Find the mesh property with integration point writer's name.
        auto const& name = ip_writer->name();
        if (!mesh_properties.existsPropertyVector<double>(name))
        {
            continue;
        }
        auto const& mesh_property =
            *mesh_properties.template getPropertyVector<double>(name);
 
        // The mesh property must be defined on integration points.
        if (mesh_property.getMeshItemType() !=
            MeshLib::MeshItemType::IntegrationPoint)
        {
            continue;
        }
 
        auto const ip_meta_data =
            getIntegrationPointMetaDataSingleField(opt_ip_meta_data_all, name);
 
        // Check the number of components.
        if (ip_meta_data.n_components !=
            mesh_property.getNumberOfGlobalComponents())
        {
            OGS_FATAL(
                "Different number of components in meta data ({:d}) than in "
                "the integration point field data for '{:s}': {:d}.",
                ip_meta_data.n_components, name,
                mesh_property.getNumberOfGlobalComponents());
        }
 
        INFO("Setting initial integration point data for '{}'", name);
 
        auto const name_transformed = removeIPFieldDataNameSuffix(name);
 
        // Now we have a properly named vtk's field data array and the
        // corresponding meta data.
        std::size_t position = 0;
        for (auto& local_asm : local_assemblers)
        {
            std::size_t const integration_points_read =
                local_asm->setIPDataInitialConditions(
                    name_transformed, &mesh_property[position],
                    ip_meta_data.integration_order);
            // The number of read integration points could be zero in case there
            // are e.g. multiple materials with different sets of internal state
            // variables.
 
            position += integration_points_read * ip_meta_data.n_components;
        }
    }
}

References MeshLib::Properties::existsPropertyVector(), MeshLib::getIntegrationPointMetaData(), INFO(), MeshLib::IntegrationPoint, OGS_FATAL, and removeIPFieldDataNameSuffix().

Referenced by ProcessLib::HydroMechanics::HydroMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::LargeDeformation::LargeDeformationProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::PhaseField::PhaseFieldProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::RichardsMechanics::RichardsMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::SmallDeformation::SmallDeformationProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::TH2M::TH2MProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::ThermoMechanics::ThermoMechanicsProcess< DisplacementDim >::initializeConcreteProcess(), ProcessLib::ThermoRichardsFlow::ThermoRichardsFlowProcess::initializeConcreteProcess(), and ProcessLib::ThermoRichardsMechanics::ThermoRichardsMechanicsProcess< DisplacementDim, ConstitutiveTraits >::initializeConcreteProcess().

setTimeDiscretizedODESystem() [1/2]

void ProcessLib::setTimeDiscretizedODESystem

(

ProcessData &

process_data

)

Definition at line 160 of file TimeLoop.cpp.

{
    setTimeDiscretizedODESystem(process_data, process_data.process);
}

References ProcessLib::ProcessData::process, and setTimeDiscretizedODESystem().

setTimeDiscretizedODESystem() [2/2]

template<NumLib::ODESystemTag ODETag>

void ProcessLib::setTimeDiscretizedODESystem	(	ProcessData &	process_data,
		NumLib::ODESystem< ODETag, NumLib::NonlinearSolverTag::Picard > &	ode_sys )

Definition at line 107 of file TimeLoop.cpp.

{
    using Tag = NumLib::NonlinearSolverTag;
    // A concrete Picard solver
    using NonlinearSolverPicard = NumLib::NonlinearSolver<Tag::Picard>;
    // A concrete Newton solver
    using NonlinearSolverNewton = NumLib::NonlinearSolver<Tag::Newton>;
 
    if (dynamic_cast<NonlinearSolverPicard*>(&process_data.nonlinear_solver))
    {
        // The Picard solver can also work with a Newton-ready ODE,
        // because the Newton ODESystem derives from the Picard ODESystem.
        // So no further checks are needed here.
 
        process_data.tdisc_ode_sys = std::make_unique<
            NumLib::TimeDiscretizedODESystem<ODETag, Tag::Picard>>(
            process_data.process_id, ode_sys, *process_data.time_disc);
    }
    // TODO (naumov) Provide a function to nonlinear_solver to distinguish the
    // types. Could be handy, because a nonlinear solver could handle both types
    // like PETScSNES.
    else if ((dynamic_cast<NonlinearSolverNewton*>(
                  &process_data.nonlinear_solver) != nullptr)
#ifdef USE_PETSC
             || (dynamic_cast<NumLib::PETScNonlinearSolver*>(
                     &process_data.nonlinear_solver) != nullptr)
#endif  // USE_PETSC
    )
    {
        // The Newton-Raphson method needs a Newton-ready ODE.
 
        using ODENewton = NumLib::ODESystem<ODETag, Tag::Newton>;
        if (auto* ode_newton = dynamic_cast<ODENewton*>(&ode_sys))
        {
            process_data.tdisc_ode_sys = std::make_unique<
                NumLib::TimeDiscretizedODESystem<ODETag, Tag::Newton>>(
                process_data.process_id, *ode_newton, *process_data.time_disc);
        }
        else
        {
            OGS_FATAL(
                "You are trying to solve a non-Newton-ready ODE with the"
                " Newton-Raphson method. Aborting");
        }
    }
    else
    {
        OGS_FATAL("Encountered unknown nonlinear solver type. Aborting");
    }
}

References ProcessLib::ProcessData::nonlinear_solver, OGS_FATAL, ProcessLib::ProcessData::process_id, ProcessLib::ProcessData::tdisc_ode_sys, and ProcessLib::ProcessData::time_disc.

Referenced by ProcessLib::TimeLoop::initialize(), and setTimeDiscretizedODESystem().

solveMonolithicProcess()

NumLib::NonlinearSolverStatus ProcessLib::solveMonolithicProcess ( const NumLib::Time & t, const double dt, const std::size_t timestep_id, ProcessData const & process_data, std::vector< GlobalVector * > & x, std::vector< GlobalVector * > const & x_prev, std::vector< Output > const & outputs )

static

Definition at line 619 of file TimeLoop.cpp.

{
    BaseLib::RunTime time_timestep_process;
    time_timestep_process.start();
 
    INFO("Solving process #{:d} started.", process_data.process_id);
 
    auto const nonlinear_solver_status = solveOneTimeStepOneProcess(
        x, x_prev, timestep_id, t(), dt, process_data, outputs);
 
    INFO("[time] Solving process #{:d} took {:g} s in time step #{:d}",
         process_data.process_id, time_timestep_process.elapsed(), timestep_id);
 
    return nonlinear_solver_status;
}

References BaseLib::RunTime::elapsed(), INFO(), ProcessLib::ProcessData::process_id, solveOneTimeStepOneProcess(), and BaseLib::RunTime::start().

Referenced by ProcessLib::TimeLoop::solveUncoupledEquationSystems().

solveOneTimeStepOneProcess()

NumLib::NonlinearSolverStatus ProcessLib::solveOneTimeStepOneProcess	(	std::vector< GlobalVector * > &	x,
		std::vector< GlobalVector * > const &	x_prev,
		std::size_t const	timestep,
		double const	t,
		double const	delta_t,
		ProcessData const &	process_data,
		std::vector< Output > const &	outputs )

Definition at line 217 of file TimeLoop.cpp.

{
    auto& process = process_data.process;
    int const process_id = process_data.process_id;
    auto& time_disc = *process_data.time_disc;
    auto& nonlinear_solver = process_data.nonlinear_solver;
 
    setEquationSystem(process_data);
 
    // Note: Order matters!
    // First advance to the next timestep, then set known solutions at that
    // time, afterwards pass the right solution vector and time to the
    // preTimestep() hook.
 
    time_disc.nextTimestep(t, delta_t);
 
    auto const post_iteration_callback =
        [&](int const iteration, bool const converged,
            std::vector<GlobalVector*> const& x)
    {
        // Note: We don't call the postNonLinearSolver(), preOutput(),
        // computeSecondaryVariable() and postTimestep() hooks here. This might
        // lead to some inconsistencies in the data compared to regular output.
        for (auto const& output : outputs)
        {
            output.doOutputNonlinearIteration(process, process_id, timestep,
                                              NumLib::Time(t), iteration,
                                              converged, x);
        }
    };
 
    auto const nonlinear_solver_status =
        nonlinear_solver.solve(x, x_prev, post_iteration_callback, process_id);
 
    if (!nonlinear_solver_status.error_norms_met)
    {
        return nonlinear_solver_status;
    }
 
    process.postNonLinearSolver(x, x_prev, t, delta_t, process_id);
 
    return nonlinear_solver_status;
}

References ProcessLib::ProcessData::nonlinear_solver, ProcessLib::ProcessData::process, ProcessLib::ProcessData::process_id, setEquationSystem(), and ProcessLib::ProcessData::time_disc.

Referenced by ProcessLib::TimeLoop::solveCoupledEquationSystemsByStaggeredScheme(), and solveMonolithicProcess().

transposeInPlace() [1/3]

template<int Components>

void ProcessLib::transposeInPlace

(

std::vector< double > &

values

)

Definition at line 35 of file TransposeInPlace.h.

{
    MathLib::toMatrix<
        Eigen::Matrix<double, Eigen::Dynamic, Components, Eigen::RowMajor>>(
        values, values.size() / Components, Components) =
        MathLib::toMatrix<
            Eigen::Matrix<double, Components, Eigen::Dynamic, Eigen::RowMajor>>(
            values, Components, values.size() / Components)
            .transpose()
            .eval();
}

References MathLib::toMatrix().

transposeInPlace() [2/3]

void ProcessLib::transposeInPlace ( std::vector< double > & values, unsigned const num_components )

inline

Definition at line 47 of file TransposeInPlace.h.

{
    MathLib::toMatrix<
        Eigen::Matrix<double, Eigen::Dynamic, Eigen::Dynamic, Eigen::RowMajor>>(
        values, values.size() / num_components, num_components) =
        MathLib::toMatrix<Eigen::Matrix<double,
                                        Eigen::Dynamic,
                                        Eigen::Dynamic,
                                        Eigen::RowMajor>>(
            values, num_components, values.size() / num_components)
            .transpose()
            .eval();
}

References MathLib::toMatrix().

transposeInPlace() [3/3]

template<int Components, typename StoreValuesFunction>

std::vector< double > ProcessLib::transposeInPlace

(

StoreValuesFunction const &

store_values_function

)

In-place transpose. A helper function for the integration point data getters. For time being Eigen's transposeInPlace doesn't work for non-square mapped matrices.

Definition at line 17 of file TransposeInPlace.h.

{
    std::vector<double> result;
    store_values_function(result);
    MathLib::toMatrix<
        Eigen::Matrix<double, Eigen::Dynamic, Components, Eigen::RowMajor>>(
        result, result.size() / Components, Components) =
        MathLib::toMatrix<
            Eigen::Matrix<double, Components, Eigen::Dynamic, Eigen::RowMajor>>(
            result, Components, result.size() / Components)
            .transpose()
            .eval();
 
    return result;
}

References MathLib::toMatrix().

Referenced by ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getEpsilon(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::getEpsilon(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getEpsilon0(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getEpsilonM(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::getEpsilonMechanical(), getIntegrationPointKelvinVectorData(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getSigma(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::getSigma(), and makeExtrapolator2().

Variable Documentation

timestepper_cannot_reduce_dt

std::string_view ProcessLib::timestepper_cannot_reduce_dt

staticconstexpr

Initial value:

=
    "Time stepper cannot reduce the time step size further."

Definition at line 639 of file TimeLoop.cpp.

Referenced by ProcessLib::TimeLoop::solveUncoupledEquationSystems().