Detailed Description

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

A parameter represented by a mesh property vector.

Definition at line 25 of file MeshElementParameter.h.

#include <MeshElementParameter.h>

Inheritance diagram for ParameterLib::MeshElementParameter< T >:

Collaboration diagram for ParameterLib::MeshElementParameter< T >:

Public Member Functions
	MeshElementParameter (std::string const &name_, MeshLib::Mesh const &mesh, MeshLib::PropertyVector< T > const &property)

bool	isTimeDependent () const override

int	getNumberOfGlobalComponents () const override

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

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

Public Member Functions inherited from ParameterLib::Parameter< T >
	~Parameter () override=default

	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

void	setCoordinateSystem (CoordinateSystem const &coordinate_system)

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

MeshLib::Mesh const *	mesh () const

Private Attributes
MeshLib::PropertyVector< T > const &	_property

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

◆ MeshElementParameter()

template<typename T >

ParameterLib::MeshElementParameter< T >::MeshElementParameter	(	std::string const &	name_,
		MeshLib::Mesh const &	mesh,
		MeshLib::PropertyVector< T > const &	property )

inline

Definition at line 27 of file MeshElementParameter.h.

        : Parameter<T>(name_, &mesh), _property(property)
    {
    }

Member Function Documentation

◆ getNodalValuesOnElement()

template<typename T >

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

inlineoverridevirtual

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

Reimplemented from ParameterLib::Parameter< T >.

Definition at line 66 of file MeshElementParameter.h.

    {
        auto const n_nodes = element.getNumberOfNodes();
        Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic> result(
            n_nodes, getNumberOfGlobalComponents());
 
        // Column vector of values, copied for each node.
        SpatialPosition x_position;
        x_position.setElementID(element.getID());
        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());
        for (unsigned i = 0; i < n_nodes; ++i)
        {
            result.row(i) = row_values;
        }
        return result;
    }

References MeshLib::Element::getID(), ParameterLib::MeshElementParameter< T >::getNumberOfGlobalComponents(), MeshLib::Element::getNumberOfNodes(), ParameterLib::MeshElementParameter< T >::operator()(), and ParameterLib::SpatialPosition::setElementID().

◆ getNumberOfGlobalComponents()

template<typename T >

int ParameterLib::MeshElementParameter< T >::getNumberOfGlobalComponents ( ) const

inlineoverridevirtual

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

Implements ParameterLib::Parameter< T >.

Definition at line 36 of file MeshElementParameter.h.

    {
        return _property.getNumberOfGlobalComponents();
    }

References ParameterLib::MeshElementParameter< T >::_property, and MeshLib::PropertyVectorBase::getNumberOfGlobalComponents().

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

◆ isTimeDependent()

template<typename T >

bool ParameterLib::MeshElementParameter< T >::isTimeDependent ( ) const

inlineoverridevirtual

Implements ParameterLib::ParameterBase.

Definition at line 34 of file MeshElementParameter.h.

34{ return false; }

◆ operator()()

template<typename T >

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

inlineoverridevirtual

Returns the parameter value at the given time and position.

Implements ParameterLib::Parameter< T >.

Definition at line 41 of file MeshElementParameter.h.

    {
        auto const e = pos.getElementID();
        if (!e)
        {
            OGS_FATAL(
                "Trying to access a MeshElementParameter but the element id is "
                "not specified.");
        }
        auto const num_comp = _property.getNumberOfGlobalComponents();
        std::vector<T> cache(num_comp);
        for (int c = 0; c < num_comp; ++c)
        {
            cache[c] = _property.getComponent(*e, c);
        }
 
        if (!this->_coordinate_system)
        {
            return cache;
        }
 
        return this->rotateWithCoordinateSystem(cache, pos);
    }