Detailed Description

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

Definition at line 22 of file CurveScaledParameter.h.

#include <CurveScaledParameter.h>

Inheritance diagram for ParameterLib::CurveScaledParameter< T >:

Collaboration diagram for ParameterLib::CurveScaledParameter< T >:

Public Member Functions
	CurveScaledParameter (std::string const &name_, MathLib::PiecewiseLinearInterpolation const &curve, std::string referenced_parameter_name)

bool	isTimeDependent () const override

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

int	getNumberOfGlobalComponents () const override

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

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

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

void	setCoordinateSystem (CoordinateSystem const &coordinate_system)

MeshLib::Mesh const *	mesh () const

Private Attributes
MathLib::PiecewiseLinearInterpolation const &	_curve

Parameter< T > const *	_parameter = nullptr

std::string const	_referenced_parameter_name

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

◆ CurveScaledParameter()

template<typename T >

ParameterLib::CurveScaledParameter< T >::CurveScaledParameter	(	std::string const &	name_,
		MathLib::PiecewiseLinearInterpolation const &	curve,
		std::string	referenced_parameter_name )

inline

Definition at line 24 of file CurveScaledParameter.h.

        : Parameter<T>(name_),
          _curve(curve),
          _referenced_parameter_name(std::move(referenced_parameter_name))
    {
    }

Member Function Documentation

◆ getNumberOfGlobalComponents()

template<typename T >

int ParameterLib::CurveScaledParameter< 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 42 of file CurveScaledParameter.h.

    {
        return _parameter->getNumberOfGlobalComponents();
    }

References ParameterLib::CurveScaledParameter< T >::_parameter.

◆ initialize()

template<typename T >

void ParameterLib::CurveScaledParameter< T >::initialize ( std::vector< std::unique_ptr< ParameterBase > > const & )

inlineoverridevirtual

Parameters might depend on each other; this method allows to set up the dependencies between parameters after they have been constructed.

Reimplemented from ParameterLib::ParameterBase.

Definition at line 34 of file CurveScaledParameter.h.

    {
        _parameter =
            &findParameter<T>(_referenced_parameter_name, parameters, 0);
        ParameterBase::_mesh = _parameter->mesh();
    }

References ParameterLib::ParameterBase::_mesh, ParameterLib::CurveScaledParameter< T >::_parameter, ParameterLib::CurveScaledParameter< T >::_referenced_parameter_name, and ParameterLib::findParameter().

◆ isTimeDependent()

template<typename T >

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

inlineoverridevirtual

Implements ParameterLib::ParameterBase.

Definition at line 33 of file CurveScaledParameter.h.

33{ return true; }

◆ operator()()

template<typename T >

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

    {
        // No local coordinate transformation here, which might happen twice
        // otherwise.
        assert(!this->_coordinate_system ||
               "Coordinate system not expected to be set for curve scaled "
               "parameters.");
 
        auto const& tup = (*_parameter)(t, pos);
        auto const scaling = _curve.getValue(t);
 
        auto const num_comp = _parameter->getNumberOfGlobalComponents();
        std::vector<T> cache(num_comp);
        for (int c = 0; c < num_comp; ++c)
        {
            cache[c] = scaling * tup[c];
        }
        return cache;
    }