Detailed Description

Base class for all parameters, not an interface class. This avoids using of void* when storing parameters and convenient destruction. Its property name helps addressing the right parameter.

Definition at line 40 of file ParameterLib/Parameter.h.

#include <Parameter.h>

Inheritance diagram for ParameterLib::ParameterBase:

[legend]

Collaboration diagram for ParameterLib::ParameterBase:

[legend]

Public Member Functions
	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

Public Attributes
std::string const	name

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

Protected Attributes
std::optional< CoordinateSystem >	_coordinate_system
MeshLib::Mesh const *	_mesh

Constructor & Destructor Documentation

◆ ParameterBase()

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

inlineexplicit

Definition at line 42 of file ParameterLib/Parameter.h.

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

References _mesh, mesh(), and name.

◆ ~ParameterBase()

virtual ParameterLib::ParameterBase::~ParameterBase ( )

virtualdefault

Member Function Documentation

◆ initialize()

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

inlinevirtual

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

Reimplemented in ParameterLib::CurveScaledParameter< T >, and ParameterLib::TimeDependentHeterogeneousParameter.

Definition at line 59 of file ParameterLib/Parameter.h.

61 {

62 }

◆ isTimeDependent()

virtual bool ParameterLib::ParameterBase::isTimeDependent ( ) const

pure virtual

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.

◆ mesh()

MeshLib::Mesh const * ParameterLib::ParameterBase::mesh ( ) const

inline

Definition at line 64 of file ParameterLib/Parameter.h.

64{ return _mesh; }

References _mesh.

Referenced by ParameterLib::GroupBasedParameter< T, MeshItemType >::GroupBasedParameter(), ParameterLib::MeshElementParameter< T >::MeshElementParameter(), ParameterLib::MeshNodeParameter< T >::MeshNodeParameter(), ParameterBase(), ParameterLib::RandomFieldMeshElementParameter< T >::RandomFieldMeshElementParameter(), and ParameterLib::isDefinedOnSameMesh().

◆ rotateWithCoordinateSystem()

std::vector< double > ParameterLib::ParameterBase::rotateWithCoordinateSystem	(	std::vector< double > const &	values,
		SpatialPosition const &	pos ) const

inlineprotected

Definition at line 69 of file ParameterLib/Parameter.h.

    {
        assert(!!_coordinate_system);  // It is checked before calling this
                                       // function.
 
        // Don't rotate isotropic/scalar values.
        if (values.size() == 1)
        {
            return {values[0]};
        }
        if (values.size() == 2)
        {
            auto const result =
                _coordinate_system->rotateDiagonalTensor<2>(values, pos);
            return {result(0, 0), result(0, 1), result(1, 0), result(1, 1)};
        }
        if (values.size() == 3)
        {
            auto const result =
                _coordinate_system->rotateDiagonalTensor<3>(values, pos);
            return {
                result(0, 0), result(0, 1), result(0, 2),
                result(1, 0), result(1, 1), result(1, 2),
                result(2, 0), result(2, 1), result(2, 2),
            };
        }
        if (values.size() == 4)
        {
            auto const result =
                _coordinate_system->rotateTensor<2>(values, pos);
            return {result(0, 0), result(0, 1), result(1, 0), result(1, 1)};
        }
        if (values.size() == 9)
        {
            auto const result =
                _coordinate_system->rotateTensor<3>(values, pos);
            return {
                result(0, 0), result(0, 1), result(0, 2),
                result(1, 0), result(1, 1), result(1, 2),
                result(2, 0), result(2, 1), result(2, 2),
            };
        }
        OGS_FATAL(
            "Coordinate transformation for a {:d}-component parameter is not "
            "implemented.",
            values.size());
    }

References _coordinate_system, and OGS_FATAL.

Referenced by ParameterLib::ConstantParameter< T >::operator()(), ParameterLib::FunctionParameter< T >::operator()(), ParameterLib::GroupBasedParameter< T, MeshItemType >::operator()(), ParameterLib::MeshElementParameter< T >::operator()(), ParameterLib::MeshNodeParameter< T >::operator()(), and ParameterLib::RandomFieldMeshElementParameter< T >::operator()().

◆ setCoordinateSystem()

void ParameterLib::ParameterBase::setCoordinateSystem ( CoordinateSystem const & coordinate_system )

inline

Definition at line 52 of file ParameterLib/Parameter.h.

    {
        _coordinate_system = coordinate_system;
    }

References _coordinate_system.

Member Data Documentation

◆ _coordinate_system

std::optional<CoordinateSystem> ParameterLib::ParameterBase::_coordinate_system

protected

Definition at line 119 of file ParameterLib/Parameter.h.

Referenced by ParameterLib::ConstantParameter< T >::operator()(), ParameterLib::CurveScaledParameter< T >::operator()(), ParameterLib::FunctionParameter< T >::operator()(), ParameterLib::GroupBasedParameter< T, MeshItemType >::operator()(), ParameterLib::MeshElementParameter< T >::operator()(), ParameterLib::MeshNodeParameter< T >::operator()(), ParameterLib::RandomFieldMeshElementParameter< T >::operator()(), ParameterLib::TimeDependentHeterogeneousParameter::operator()(), rotateWithCoordinateSystem(), and setCoordinateSystem().

◆ _mesh

MeshLib::Mesh const* ParameterLib::ParameterBase::_mesh

protected

A mesh on which the parameter is defined. Some parameters might be mesh-independent.

Definition at line 123 of file ParameterLib/Parameter.h.

Referenced by ParameterBase(), ParameterLib::CurveScaledParameter< T >::initialize(), and mesh().

◆ name

std::string const ParameterLib::ParameterBase::name

Definition at line 66 of file ParameterLib/Parameter.h.

Referenced by ParameterLib::CoordinateSystem::CoordinateSystem(), ParameterLib::FunctionParameter< T >::FunctionParameter(), ParameterBase(), ParameterLib::TimeDependentHeterogeneousParameter::TimeDependentHeterogeneousParameter(), ProcessLib::HT::createHTProcess(), ParameterLib::TimeDependentHeterogeneousParameter::initialize(), and ParameterLib::CoordinateSystem::transformation().

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

ParameterLib/Parameter.h