Detailed Description

template<typename T>
struct ParameterLib::Parameter< T >

A Parameter is a function \( (t, x) \mapsto f(t, x) \in T^n \).

Where \( t \) is the time and \( x \) is the SpatialPosition. \( n \) is the number of components of \(f\)'s results, i.e., 1 for a scalar parameter and >1 for a vectorial or tensorial parameter.

Definition at line 23 of file WellboreGeometry.h.

#include <Parameter.h>

Inheritance diagram for ParameterLib::Parameter< T >:

[legend]

Collaboration diagram for ParameterLib::Parameter< T >:

[legend]

Public Member Functions
	~Parameter () override=default

virtual int	getNumberOfGlobalComponents () const =0

virtual std::vector< T >	operator() (double const t, SpatialPosition const &pos) const =0
	Returns the parameter value at the given time and position.

virtual Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic >	getNodalValuesOnElement (MeshLib::Element const &element, double const t) const
	Returns a matrix of values for all nodes of the given element.

	ParameterBase (std::string name_, MeshLib::Mesh const *mesh=nullptr)

Public Member Functions inherited from ParameterLib::ParameterBase
	ParameterBase (std::string name_, MeshLib::Mesh const *mesh=nullptr)

virtual	~ParameterBase ()=default

virtual bool	isTimeDependent () const =0

void	setCoordinateSystem (CoordinateSystem const &coordinate_system)

virtual void	initialize (std::vector< std::unique_ptr< ParameterBase > > const &)

MeshLib::Mesh const *	mesh () const

Additional Inherited Members
Public Attributes inherited from ParameterLib::ParameterBase
std::string const	name

Protected Member Functions inherited from ParameterLib::ParameterBase
std::vector< double >	rotateWithCoordinateSystem (std::vector< double > const &values, SpatialPosition const &pos) const

Protected Attributes inherited from ParameterLib::ParameterBase
std::optional< CoordinateSystem >	_coordinate_system

MeshLib::Mesh const *	_mesh

Constructor & Destructor Documentation

◆ ~Parameter()

template<typename T >

ParameterLib::Parameter< T >::~Parameter ( )

overridedefault

Member Function Documentation

◆ getNodalValuesOnElement()

template<typename T >

virtual Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > ParameterLib::Parameter< T >::getNodalValuesOnElement	(	MeshLib::Element const &	element,
		double const	t ) const

inlinevirtual

Returns a matrix of values for all nodes of the given element.

Reimplemented in ParameterLib::ConstantParameter< T >, ParameterLib::MeshElementParameter< T >, ParameterLib::MeshNodeParameter< T >, ParameterLib::RandomFieldMeshElementParameter< T >, and ParameterLib::RasterParameter.

Definition at line 164 of file Parameter.h.

    {
        auto const n_nodes = static_cast<int>(element.getNumberOfNodes());
        auto const n_components = getNumberOfGlobalComponents();
        Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic> result(n_nodes,
                                                                n_components);
 
        // Column vector of values, copied for each node.
        SpatialPosition x_position;
        auto const nodes = element.getNodes();
        for (int i = 0; i < n_nodes; ++i)
        {
            x_position.setAll(
                nodes[i]->getID(), element.getID(), std::nullopt, *nodes[i]);
            auto const& values = this->operator()(t, x_position);
            auto const row_values =
                Eigen::Map<Eigen::Matrix<T, Eigen::Dynamic, 1> const>(
                    values.data(), values.size());
            result.row(i) = row_values;
        }
 
        return result;
    }

References MeshLib::Element::getID(), MeshLib::Element::getNodes(), ParameterLib::Parameter< T >::getNumberOfGlobalComponents(), MeshLib::Element::getNumberOfNodes(), ParameterLib::Parameter< T >::operator()(), and ParameterLib::SpatialPosition::setAll().

Referenced by ProcessLib::WellboreSimulator::WellboreSimulatorFEM< ShapeFunction, GlobalDim >::WellboreSimulatorFEM(), ProcessLib::HCNonAdvectiveFreeComponentFlowBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::NeumannBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::NormalTractionBoundaryCondition::NormalTractionBoundaryConditionLocalAssembler< ShapeFunctionDisplacement, GlobalDim >::assemble(), ProcessLib::RobinBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::VariableDependentNeumannBoundaryConditionLocalAssembler< ShapeFunction, GlobalDim >::assemble(), ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::assembleWithJacobianComponentTransportEquation(), and ProcessLib::ComponentTransport::LocalAssemblerData< ShapeFunction, GlobalDim >::getLocalTemperature().

◆ getNumberOfGlobalComponents()

template<typename T >

virtual int ParameterLib::Parameter< T >::getNumberOfGlobalComponents ( ) const

pure virtual

Returns the number of components this Parameter has at every position and point in time.

Implemented in ParameterLib::ConstantParameter< T >, ParameterLib::CurveScaledParameter< T >, ParameterLib::FunctionParameter< T >, ParameterLib::GroupBasedParameter< T, MeshItemType >, ParameterLib::MeshElementParameter< T >, ParameterLib::MeshNodeParameter< T >, ParameterLib::RandomFieldMeshElementParameter< T >, ParameterLib::RasterParameter, and ParameterLib::TimeDependentHeterogeneousParameter.

Referenced by MaterialLib::PorousMedium::Permeability::Permeability(), ParameterLib::Parameter< T >::getNodalValuesOnElement(), and ParameterLib::TimeDependentHeterogeneousParameter::getNumberOfGlobalComponents().

◆ operator()()

template<typename T >

virtual std::vector< T > ParameterLib::Parameter< T >::operator()	(	double const	t,
		SpatialPosition const &	pos ) const

pure virtual

Returns the parameter value at the given time and position.

Implemented in ParameterLib::ConstantParameter< T >, ParameterLib::CurveScaledParameter< T >, ParameterLib::FunctionParameter< T >, ParameterLib::GroupBasedParameter< T, MeshItemType >, ParameterLib::MeshElementParameter< T >, ParameterLib::MeshNodeParameter< T >, ParameterLib::RandomFieldMeshElementParameter< T >, ParameterLib::RasterParameter, and ParameterLib::TimeDependentHeterogeneousParameter.

Referenced by ParameterLib::Parameter< T >::getNodalValuesOnElement().

◆ ParameterBase()

template<typename T >

ParameterLib::ParameterBase::ParameterBase	(	std::string	name_,
		MeshLib::Mesh const *	mesh = nullptr )

inlineexplicit

Definition at line 49 of file Parameter.h.

        : name(std::move(name_)), _mesh(mesh)
    {
    }

The documentation for this struct was generated from the following files:

MaterialLib/MPL/Properties/EffectiveThermalConductivityPorosityMixing.h
MaterialLib/MPL/Properties/GasPressureDependentPermeability.h
MaterialLib/MPL/Properties/PermeabilityMohrCoulombFailureIndexModel.h
MaterialLib/MPL/Properties/StrainDependentPermeability.h
MaterialLib/MPL/Properties/ThermalConductivity/SaturationWeightedThermalConductivity.h
ParameterLib/CoordinateSystem.h
ParameterLib/Parameter.h
ProcessLib/BoundaryConditionAndSourceTerm/DeactivatedSubdomainDirichlet.h
ProcessLib/BoundaryConditionAndSourceTerm/DirichletBoundaryCondition.h
ProcessLib/BoundaryConditionAndSourceTerm/DirichletBoundaryConditionAuxiliaryFunctions.h
ProcessLib/BoundaryConditionAndSourceTerm/DirichletBoundaryConditionWithinTimeInterval.h
ProcessLib/BoundaryConditionAndSourceTerm/PrimaryVariableConstraintDirichletBoundaryCondition.h
ProcessLib/DeactivatedSubdomain.h
ProcessLib/LIE/Common/FractureProperty.h
ProcessLib/ProcessVariable.h
ProcessLib/WellboreSimulator/ReservoirProperties.h
ProcessLib/WellboreSimulator/WellboreGeometry.h

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~Parameter()

Member Function Documentation

◆ getNodalValuesOnElement()

◆ getNumberOfGlobalComponents()

◆ operator()()

◆ ParameterBase()