Detailed Description

template<int DisplacementDim, typename TDynForces>
class MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >

Provides convenient access to the individual blocks of MFront's thermodynamic forces data.

Template Parameters

DisplacementDim	the displacement dimension
TDynForces	a list (of types) of thermodynamic forces

"Thermodynamic forces" is MFront nomenclature for the data an MFront behaviour computes.

TDynForces is a list of types. Each is expected to behave like Strain and the other classes in Variable.h.

MFront's thermodynamic forces are stored in a single vector of double values. The data of forces that come earlier in TDynForces are stored earlier in MFront's data.

Definition at line 42 of file ThermodynamicForcesView.h.

#include <ThermodynamicForcesView.h>

Classes
struct	SizeOf
	A template metafunction accessing the size of the given `Variable`. More...

Public Member Functions
template<typename Force >
auto	block (Force force, OGSMFrontThermodynamicForcesData const &data) const
	Read-only access to the data for the given thermodynamic force `Force`.

template<typename Force >
auto	block (Force, std::vector< double > const &data) const
	Overload taking a std::vector.

template<typename Force , std::enable_if_t< SizeOf< Force >::value==1, bool > = true>
double &	block (Force force, OGSMFrontThermodynamicForcesData &data) const

template<typename Force , std::enable_if_t< SizeOf< Force >::value==1, bool > = true>
double &	block (Force, std::vector< double > &data) const
	Overload taking a std::vector.

template<typename Force , std::enable_if_t< SizeOf< Force >::value !=1, bool > = true>
auto	block (Force force, OGSMFrontThermodynamicForcesData &data) const

template<typename Force , std::enable_if_t< SizeOf< Force >::value !=1, bool > = true>
auto	block (Force, std::vector< double > &data) const
	Overload taking a std::vector.

Static Public Attributes
static constexpr std::size_t	data_size_all_forces
	The passed data to the block() methods must have this size.

Static Private Member Functions
template<typename Force >
static constexpr std::size_t	dataOffset ()

template<typename Force , typename DataVector >
static constexpr auto	asEigenMap (DataVector &data)
	Access a block of the given `data` as an Eigen::Map.

template<typename Force , typename DataVector >
static constexpr auto &	asDouble (DataVector &data)
	Access a block of the given `data` as a double value.

Member Function Documentation

◆ asDouble()

template<int DisplacementDim, typename TDynForces >

template<typename Force , typename DataVector >

static constexpr auto & MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::asDouble ( DataVector & data )

inlinestaticconstexprprivate

Access a block of the given data as a double value.

Definition at line 97 of file ThermodynamicForcesView.h.

    {
        static_assert(Force::template size<DisplacementDim>() == 1,
                      "Use asEigenMap for the multi component case.");
 
        assert(data.size() == data_size_all_forces);
 
        constexpr std::size_t data_offset = dataOffset<Force>();
 
        return data[data_offset];
    }

References MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::data_size_all_forces.

◆ asEigenMap()

template<int DisplacementDim, typename TDynForces >

template<typename Force , typename DataVector >

static constexpr auto MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::asEigenMap ( DataVector & data )

inlinestaticconstexprprivate

Access a block of the given data as an Eigen::Map.

Definition at line 74 of file ThermodynamicForcesView.h.

    {
        static_assert(Force::template size<DisplacementDim>() != 1,
                      "Use asDouble for the single component case.");
 
        assert(data.size() == data_size_all_forces);
 
        constexpr std::size_t data_offset = dataOffset<Force>();
 
        constexpr std::size_t rows = Force::template rows<DisplacementDim>();
        constexpr std::size_t cols = Force::template cols<DisplacementDim>();
        constexpr auto order = cols == 1 ? Eigen::ColMajor : Eigen::RowMajor;
 
        using MatrixType =
            std::conditional_t<std::is_const_v<DataVector>,
                               const Eigen::Matrix<double, rows, cols, order>,
                               Eigen::Matrix<double, rows, cols, order>>;
 
        return Eigen::Map<MatrixType>(data.data() + data_offset);
    }

References MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::data_size_all_forces.

◆ block() [1/6]

template<int DisplacementDim, typename TDynForces >

template<typename Force , std::enable_if_t< SizeOf< Force >::value==1, bool > = true>

double & MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block	(	Force	force,
		OGSMFrontThermodynamicForcesData &	data ) const

inline

Read-write access to the data for the given thermodynamic force Force.

This overload is chosen if Force has one component.

Definition at line 140 of file ThermodynamicForcesView.h.

    {
        return block(force, data.data);
    }

References MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block(), and MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesData::data.

◆ block() [2/6]

template<int DisplacementDim, typename TDynForces >

template<typename Force , std::enable_if_t< SizeOf< Force >::value !=1, bool > = true>

auto MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block	(	Force	force,
		OGSMFrontThermodynamicForcesData &	data ) const

inline

Read-write access to the data for the given thermodynamic force Force.

This overload is chosen if Force has more than one component.

Definition at line 159 of file ThermodynamicForcesView.h.

    {
        return block(force, data.data);
    }

References MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block(), and MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesData::data.

◆ block() [3/6]

template<int DisplacementDim, typename TDynForces >

template<typename Force >

auto MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block	(	Force	force,
		OGSMFrontThermodynamicForcesData const &	data ) const

inline

Read-only access to the data for the given thermodynamic force Force.

Definition at line 112 of file ThermodynamicForcesView.h.

    {
        return block(force, data.data);
    }

References MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block(), and MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesData::data.

Referenced by MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block(), and MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block().

◆ block() [4/6]

template<int DisplacementDim, typename TDynForces >

template<typename Force , std::enable_if_t< SizeOf< Force >::value==1, bool > = true>

double & MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block	(	Force	,
		std::vector< double > &	data ) const

inline

Overload taking a std::vector.

Definition at line 148 of file ThermodynamicForcesView.h.

    {
        return asDouble<Force>(data);
    }

◆ block() [5/6]

template<int DisplacementDim, typename TDynForces >

template<typename Force , std::enable_if_t< SizeOf< Force >::value !=1, bool > = true>

auto MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block	(	Force	,
		std::vector< double > &	data ) const

inline

Overload taking a std::vector.

Definition at line 167 of file ThermodynamicForcesView.h.

    {
        return asEigenMap<Force>(data);
    }

◆ block() [6/6]

template<int DisplacementDim, typename TDynForces >

template<typename Force >

auto MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::block	(	Force	,
		std::vector< double > const &	data ) const

inline

Overload taking a std::vector.

Definition at line 119 of file ThermodynamicForcesView.h.

    {
        constexpr std::size_t data_size =
            Force::template size<DisplacementDim>();
 
        if constexpr (data_size == 1)
        {
            return asDouble<Force>(data);
        }
        else
        {
            return asEigenMap<Force>(data);
        }
    }

◆ dataOffset()

template<int DisplacementDim, typename TDynForces >

template<typename Force >

static constexpr std::size_t MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::dataOffset ( )

inlinestaticconstexprprivate

Computes the offset of the given Force's data in MFront's thermodynamic forces data.

Definition at line 57 of file ThermodynamicForcesView.h.

    {
        using namespace boost::mp11;
        static_assert(mp_contains<TDynForces, Force>::value,
                      "The type Force is not in the list TDynForces.");
 
        using ForceIndex = mp_find<TDynForces, Force>;
 
        using ForcesHead = mp_take<TDynForces, ForceIndex>;
 
        using Sizes = mp_transform<SizeOf, ForcesHead>;
 
        return mp_apply<mp_plus, Sizes>::value;
    }

Member Data Documentation

◆ data_size_all_forces

template<int DisplacementDim, typename TDynForces >

constexpr std::size_t MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::data_size_all_forces

staticconstexpr

Initial value:

= boost::mp11::mp_apply<
        boost::mp11::mp_plus,
        boost::mp11::mp_transform<SizeOf, TDynForces>>::value

The passed data to the block() methods must have this size.

Definition at line 173 of file ThermodynamicForcesView.h.

Referenced by MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::asDouble(), and MaterialLib::Solids::MFront::OGSMFrontThermodynamicForcesView< DisplacementDim, TDynForces >::asEigenMap().

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

MaterialLib/SolidModels/MFront/ThermodynamicForcesView.h

Detailed Description

Classes

Public Member Functions

Static Public Attributes

Static Private Member Functions

Member Function Documentation

◆ asDouble()

◆ asEigenMap()

◆ block() [1/6]

◆ block() [2/6]

◆ block() [3/6]

◆ block() [4/6]

◆ block() [5/6]

◆ block() [6/6]

◆ dataOffset()

Member Data Documentation

◆ data_size_all_forces