ParameterLib::ConstantParameter< T > Struct Template Reference

Detailed Description

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

Single, constant value parameter.

Definition at line 12 of file ConstantParameter.h.

#include <ConstantParameter.h>

Inheritance diagram for ParameterLib::ConstantParameter< T >:

Collaboration diagram for ParameterLib::ConstantParameter< T >:

Public Member Functions
	ConstantParameter (std::string const &name_, T const &value)
	Construction with single value.
	ConstantParameter (std::string const &name_, std::vector< T > values)
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) 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
std::vector< T > const	_values

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

ConstantParameter() [1/2]

template<typename T>

ParameterLib::ConstantParameter< T >::ConstantParameter ( std::string const & name_, T const & value )

inlineexplicit

Construction with single value.

Definition at line 15 of file ConstantParameter.h.

        : Parameter<T>(name_), _values({value})
    {
    }

References _values.

ConstantParameter() [2/2]

template<typename T>

ParameterLib::ConstantParameter< T >::ConstantParameter ( std::string const & name_, std::vector< T > values )

inlineexplicit

Construction with a tuple. The given tuple must be non-empty.

Definition at line 22 of file ConstantParameter.h.

        : Parameter<T>(name_), _values(std::move(values))
    {
        assert(!_values.empty());
    }

References _values.

Member Function Documentation

getNodalValuesOnElement()

template<typename T>

Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > ParameterLib::ConstantParameter< 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 46 of file ConstantParameter.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.
        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 _values, getNumberOfGlobalComponents(), and MeshLib::Element::getNumberOfNodes().

getNumberOfGlobalComponents()

template<typename T>

int ParameterLib::ConstantParameter< 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 30 of file ConstantParameter.h.

    {
        return static_cast<int>(_values.size());
    }

References _values.

Referenced by getNodalValuesOnElement().

isTimeDependent()

template<typename T>

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

inlineoverridevirtual

Implements ParameterLib::ParameterBase.

Definition at line 28 of file ConstantParameter.h.

{ return false; }

operator()()

template<typename T>

std::vector< T > ParameterLib::ConstantParameter< 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 35 of file ConstantParameter.h.

    {
        if (!this->_coordinate_system)
        {
            return _values;
        }
 
        return this->rotateWithCoordinateSystem(_values, pos);
    }

References ParameterLib::ParameterBase::_coordinate_system, _values, and ParameterLib::ParameterBase::rotateWithCoordinateSystem().

Member Data Documentation

_values

template<typename T>

std::vector<T> const ParameterLib::ConstantParameter< T >::_values

private

Definition at line 65 of file ConstantParameter.h.

Referenced by ConstantParameter(), ConstantParameter(), getNodalValuesOnElement(), getNumberOfGlobalComponents(), and operator()().

---

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

• ConstantParameter.h