OGS
ParameterLib::SpatialPosition Class Reference

Detailed Description

Represents a position in space which can be either one of a node, an element, an integration point or a cartesian coordinates triple.

The setters of this class make sure that only compatible information can be stored at the same time; e.g., it is not possible to specify an element ID and a node ID at the same time (the constructor being an exception to that rule).

Definition at line 20 of file SpatialPosition.h.

#include <SpatialPosition.h>

Collaboration diagram for ParameterLib::SpatialPosition:
[legend]

Public Member Functions

 SpatialPosition ()=default
 SpatialPosition (std::optional< std::size_t > const &node_id, std::optional< std::size_t > const &element_id, std::optional< MathLib::Point3d > const &coordinates)
std::optional< std::size_t > getNodeID () const
std::optional< std::size_t > getElementID () const
std::optional< MathLib::Point3d > const getCoordinates () const
void setNodeID (std::size_t node_id)
void setElementID (std::size_t element_id)
void setCoordinates (MathLib::Point3d const &coordinates)

Private Attributes

std::size_t _node_id = 0
std::size_t _element_id = 0
MathLib::Point3d _coordinates {}
std::bitset< 3 > flags {}

Static Private Attributes

static constexpr std::size_t node_bit = 0
static constexpr std::size_t element_bit = 1
static constexpr std::size_t coordinates_bit = 2

Constructor & Destructor Documentation

◆ SpatialPosition() [1/2]

ParameterLib::SpatialPosition::SpatialPosition ( )
default

◆ SpatialPosition() [2/2]

ParameterLib::SpatialPosition::SpatialPosition ( std::optional< std::size_t > const & node_id,
std::optional< std::size_t > const & element_id,
std::optional< MathLib::Point3d > const & coordinates )
inline

Definition at line 25 of file SpatialPosition.h.

28 {
29 if (node_id)
30 {
31 _node_id = *node_id;
32 flags.set(node_bit);
33 }
34
35 if (element_id)
36 {
37 _element_id = *element_id;
38 flags.set(element_bit);
39 }
40 if (coordinates)
41 {
42 _coordinates = *coordinates;
43 flags.set(coordinates_bit);
44 }
45 }
ParameterLib::SpatialPosition::element_bit
static constexpr std::size_t element_bit
Definition SpatialPosition.h:89
ParameterLib::SpatialPosition::coordinates_bit
static constexpr std::size_t coordinates_bit
Definition SpatialPosition.h:90
ParameterLib::SpatialPosition::node_bit
static constexpr std::size_t node_bit
Definition SpatialPosition.h:88

References _coordinates, _element_id, _node_id, coordinates_bit, element_bit, flags, and node_bit.

Member Function Documentation

◆ getCoordinates()

std::optional< MathLib::Point3d > const ParameterLib::SpatialPosition::getCoordinates ( ) const
inline

Definition at line 56 of file SpatialPosition.h.

57 {
58 return flags[coordinates_bit] ? std::make_optional(_coordinates)
59 : std::nullopt;
60 }

References _coordinates, coordinates_bit, and flags.

Referenced by ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assemble(), ProcessLib::TH2M::TH2MLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assemble(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleBlockMatricesWithJacobian(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobian(), ProcessLib::LargeDeformation::LargeDeformationLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerMatrix< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerMatrixNearFracture< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobian(), ProcessLib::SmallDeformation::SmallDeformationLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::TH2M::TH2MLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobian(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobian(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobianForDeformationEquations(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobianForDeformationEquations(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobianForDeformationEquations(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobianPhaseFieldEquations(), ProcessLib::ThermoRichardsMechanics::ThermoRichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunction, DisplacementDim, ConstitutiveTraits >::assembleWithJacobianSingleIP(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::computeSecondaryVariableConcrete(), ProcessLib::ThermoRichardsMechanics::ThermoRichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunction, DisplacementDim, ConstitutiveTraits >::computeSecondaryVariableConcrete(), MaterialPropertyLib::evaluateExpressions(), ParameterLib::FunctionParameter< T >::operator()(), ParameterLib::RasterParameter::operator()(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::postNonLinearSolverConcrete(), ProcessLib::LargeDeformation::LargeDeformationLocalAssembler< ShapeFunction, DisplacementDim >::postTimestepConcrete(), ProcessLib::SmallDeformation::SmallDeformationLocalAssembler< ShapeFunction, DisplacementDim >::postTimestepConcrete(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::postTimestepConcrete(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::postTimestepConcreteWithBlockVectors(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setInitialConditionsConcrete(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setInitialConditionsConcrete(), ProcessLib::SmallDeformation::SmallDeformationLocalAssembler< ShapeFunction, DisplacementDim >::setInitialConditionsConcrete(), ProcessLib::TH2M::TH2MLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setInitialConditionsConcrete(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::setInitialConditionsConcrete(), anonymous_namespace{ogs_mpl.cpp}::spatialPositionCoordsToPython(), ProcessLib::ThermoHydroMechanics::ThermoHydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::updateConstitutiveRelations(), ProcessLib::TH2M::TH2MLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::updateConstitutiveVariables(), ProcessLib::TH2M::TH2MLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::updateConstitutiveVariablesDerivatives(), MaterialPropertyLib::Curve::value(), MaterialPropertyLib::Exponential::value(), and MaterialPropertyLib::IndependentVariable::valueUnclamped().

◆ getElementID()

std::optional< std::size_t > ParameterLib::SpatialPosition::getElementID ( ) const
inline

Definition at line 51 of file SpatialPosition.h.

52 {
53 return flags[element_bit] ? std::make_optional(_element_id)
54 : std::nullopt;
55 }

References _element_id, element_bit, and flags.

Referenced by ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobianEvalConstitutiveSetting(), anonymous_namespace{ogs_mpl.cpp}::bindSpatialPosition(), ProcessLib::ThermoRichardsMechanics::ConstitutiveStress_StrainTemperature::ConstitutiveSetting< DisplacementDim >::eval(), ProcessLib::ThermoRichardsMechanics::ConstitutiveStressSaturation_StrainPressureTemperature::ConstitutiveSetting< DisplacementDim >::eval(), ParameterLib::GroupBasedParameter< T, MeshItemType >::getMeshItemID(), ParameterLib::MeshElementParameter< T >::operator()(), and ParameterLib::RandomFieldMeshElementParameter< T >::operator()().

◆ getNodeID()

std::optional< std::size_t > ParameterLib::SpatialPosition::getNodeID ( ) const
inline

Definition at line 47 of file SpatialPosition.h.

48 {
49 return flags[node_bit] ? std::make_optional(_node_id) : std::nullopt;
50 }

References _node_id, flags, and node_bit.

Referenced by anonymous_namespace{ogs_mpl.cpp}::bindSpatialPosition(), ParameterLib::GroupBasedParameter< T, MeshItemType >::getMeshItemID(), and ParameterLib::MeshNodeParameter< T >::operator()().

◆ setCoordinates()

void ParameterLib::SpatialPosition::setCoordinates ( MathLib::Point3d const & coordinates)
inline

Definition at line 76 of file SpatialPosition.h.

77 {
78 _coordinates = coordinates;
79 flags.set(coordinates_bit);
80 }

References _coordinates, coordinates_bit, and flags.

Referenced by ProcessLib::ReleaseNodalForce::applyNaturalBC(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleBlockMatrices(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleKCmCn(), anonymous_namespace{ogs_mpl.cpp}::bindVariableArray(), ProcessLib::createReleaseNodalForce(), ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::getEssentialBCValues(), ProcessLib::TimeDecayDirichletBoundaryCondition::getEssentialBCValues(), ProcessLib::getEssentialBCValuesLocal(), ParameterLib::RasterParameter::getNodalValuesOnElement(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::initializeChemicalSystemConcrete(), and ProcessLib::NodalSourceTerm::integrate().

◆ setElementID()

void ParameterLib::SpatialPosition::setElementID ( std::size_t element_id)
inline

Definition at line 69 of file SpatialPosition.h.

70 {
71 flags.reset();
72 flags.set(element_bit);
73 _element_id = element_id;
74 }

References _element_id, element_bit, and flags.

Referenced by ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::HMPhaseFieldLocalAssembler(), ProcessLib::HT::HTFEM< ShapeFunction, GlobalDim >::HTFEM(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::HydroMechanicsLocalAssemblerMatrix(), ProcessLib::LiquidFlow::LiquidFlowLocalAssembler< ShapeFunction, GlobalDim >::LiquidFlowLocalAssembler(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::LocalAssemblerData(), ProcessLib::PhaseField::PhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::PhaseFieldLocalAssembler(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::ThermoMechanicsLocalAssembler(), ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::WellboreSimulatorFEM(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::approximateFractureWidth(), ProcessLib::RichardsFlow::LocalAssemblerData< ShapeFunction, GlobalDim >::assemble(), ProcessLib::RichardsMechanics::RichardsMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assemble(), ProcessLib::SteadyStateDiffusion::LocalAssemblerData< ShapeFunction, GlobalDim >::assemble(), ProcessLib::TwoPhaseFlowWithPP::TwoPhaseFlowWithPPLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::WellboreCompensateNeumannBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::assemble(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleBlockMatrices(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerFracture< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleBlockMatricesWithJacobian(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleBlockMatricesWithJacobian(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleComponentTransportEquation(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleHeatTransportEquation(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleHydraulicEquation(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleKCmCn(), ProcessLib::LiquidFlow::LiquidFlowLocalAssembler< ShapeFunction, GlobalDim >::assembleMatrixAndVector(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleReactionEquationConcrete(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobian(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerFracture< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::ThermoMechanics::ThermoMechanicsLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobian(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleWithJacobianComponentTransportEquation(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobianForDeformationEquations(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::assembleWithJacobianForPressureEquations(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleWithJacobianHydraulicEquation(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobianHydroEquations(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::assembleWithJacobianPhaseFieldEquations(), anonymous_namespace{ogs_mpl.cpp}::bindSpatialPosition(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::calculateIntPtDarcyVelocity(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::calculateIntPtLiquidDensity(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::computeEnergy(), ProcessLib::SmallDeformation::SmallDeformationLocalAssemblerInterface< DisplacementDim >::computeSecondaryVariableConcrete(), ProcessLib::LIE::SmallDeformation::SmallDeformationLocalAssemblerFracture< ShapeFunction, DisplacementDim >::computeSecondaryVariableConcreteWithVector(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::getFlux(), ProcessLib::HT::HTFEM< ShapeFunction, GlobalDim >::getFlux(), ProcessLib::LiquidFlow::LiquidFlowLocalAssembler< ShapeFunction, GlobalDim >::getFlux(), ProcessLib::SteadyStateDiffusion::LocalAssemblerData< ShapeFunction, GlobalDim >::getFlux(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::getIntPtDarcyVelocity(), ProcessLib::RichardsFlow::LocalAssemblerData< ShapeFunction, GlobalDim >::getIntPtDarcyVelocity(), ProcessLib::SteadyStateDiffusion::LocalAssemblerData< ShapeFunction, GlobalDim >::getIntPtDarcyVelocity(), ProcessLib::HT::HTFEM< ShapeFunction, GlobalDim >::getIntPtDarcyVelocityLocal(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::getIntPtMolarFlux(), ParameterLib::MeshElementParameter< T >::getNodalValuesOnElement(), ParameterLib::RandomFieldMeshElementParameter< T >::getNodalValuesOnElement(), ProcessLib::EmbeddedAnchor< GlobalDim >::getShapeMatricesAndGlobalIndicesAndDisplacements(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::initializeChemicalSystemConcrete(), ProcessLib::HMPhaseField::HMPhaseFieldLocalAssembler< ShapeFunction, DisplacementDim >::initializeConcrete(), ProcessLib::AnchorTerm< GlobalDim >::integrate(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::postNonLinearSolverConcrete(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::postSpeciationCalculation(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::postTimestepConcrete(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::postTimestepConcreteWithBlockVectors(), ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerFracture< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::postTimestepConcreteWithVector(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::setChemicalSystemConcrete(), ProcessLib::HydroMechanics::HydroMechanicsLocalAssembler< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setInitialConditionsConcrete(), ProcessLib::TwoPhaseFlowWithPP::TwoPhaseFlowWithPPLocalAssembler< ShapeFunction, GlobalDim >::setInitialConditionsConcrete(), and ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setPressureOfInactiveNodes().

◆ setNodeID()

void ParameterLib::SpatialPosition::setNodeID ( std::size_t node_id)
inline

Definition at line 62 of file SpatialPosition.h.

63 {
64 flags.reset();
65 flags.set(node_bit);
66 _node_id = node_id;
67 }

References _node_id, flags, and node_bit.

Referenced by ProcessLib::SolutionDependentDirichletBoundaryCondition::SolutionDependentDirichletBoundaryCondition(), ProcessLib::ReleaseNodalForce::applyNaturalBC(), anonymous_namespace{ogs_mpl.cpp}::bindSpatialPosition(), ProcessLib::createReleaseNodalForce(), ProcessLib::PrimaryVariableConstraintDirichletBoundaryCondition::getEssentialBCValues(), ProcessLib::TimeDecayDirichletBoundaryCondition::getEssentialBCValues(), ProcessLib::getEssentialBCValuesLocal(), ParameterLib::MeshNodeParameter< T >::getNodalValuesOnElement(), ProcessLib::NodalSourceTerm::integrate(), and ProcessLib::LIE::HydroMechanics::HydroMechanicsLocalAssemblerMatrix< ShapeFunctionDisplacement, ShapeFunctionPressure, DisplacementDim >::setPressureOfInactiveNodes().

Member Data Documentation

◆ _coordinates

MathLib::Point3d ParameterLib::SpatialPosition::_coordinates {}
private

Definition at line 85 of file SpatialPosition.h.

85{};

Referenced by SpatialPosition(), getCoordinates(), and setCoordinates().

◆ _element_id

std::size_t ParameterLib::SpatialPosition::_element_id = 0
private

Definition at line 84 of file SpatialPosition.h.

Referenced by SpatialPosition(), getElementID(), and setElementID().

◆ _node_id

std::size_t ParameterLib::SpatialPosition::_node_id = 0
private

Definition at line 83 of file SpatialPosition.h.

Referenced by SpatialPosition(), getNodeID(), and setNodeID().

◆ coordinates_bit

std::size_t ParameterLib::SpatialPosition::coordinates_bit = 2
staticconstexprprivate

Definition at line 90 of file SpatialPosition.h.

Referenced by SpatialPosition(), getCoordinates(), and setCoordinates().

◆ element_bit

std::size_t ParameterLib::SpatialPosition::element_bit = 1
staticconstexprprivate

Definition at line 89 of file SpatialPosition.h.

Referenced by SpatialPosition(), getElementID(), and setElementID().

◆ flags

std::bitset<3> ParameterLib::SpatialPosition::flags {}
private

Definition at line 87 of file SpatialPosition.h.

87{};

Referenced by SpatialPosition(), getCoordinates(), getElementID(), getNodeID(), setCoordinates(), setElementID(), and setNodeID().

◆ node_bit

std::size_t ParameterLib::SpatialPosition::node_bit = 0
staticconstexprprivate

Definition at line 88 of file SpatialPosition.h.

Referenced by SpatialPosition(), getNodeID(), and setNodeID().

The documentation for this class was generated from the following file: