MaterialStateManager.hxx File Reference

#include <map>
#include <span>
#include <string>
#include <vector>
#include <variant>
#include <optional>
#include <string_view>
#include "MGIS/Config.hxx"
#include "MGIS/StorageMode.hxx"

Classes
struct	mgis::behaviour::MaterialStateManagerInitializer
	a structure in charge of holding information on how a material state manager shall be initialized. It may contain pointers to externally allocated data, that won't be handled by the final state manager. If a pointer is not initialized, the material state manager will allocate and handle memory internally. More...
struct	mgis::behaviour::MaterialStateManager
	structure in charge of handling the state of a material in an optimized way. Here, the "material" is defined by a behaviour and a number of integration points. More...
struct	mgis::behaviour::MaterialStateManager::MutableFieldHolder
	a structure defining a mutable field holder More...
struct	mgis::behaviour::MaterialStateManager::FieldHolder

Namespaces
namespace	mgis
	the namespace mgis encloses all the MGIS project.

Functions
MGIS_EXPORT void	mgis::behaviour::setMaterialProperty (MaterialStateManager &, std::string_view, const real, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE)
	set the given material property
MGIS_EXPORT void	mgis::behaviour::setMaterialProperty (MaterialStateManager &, std::string_view, std::span< mgis::real >, const MaterialStateManager::StorageMode=MaterialStateManager::LOCAL_STORAGE, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE)
	set the given material property
MGIS_EXPORT bool	mgis::behaviour::setMaterialProperty (Context &, MaterialStateManager &, std::string_view, const real, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE) noexcept
	set the given material property
MGIS_EXPORT bool	mgis::behaviour::setMaterialProperty (Context &, MaterialStateManager &, std::string_view, std::span< mgis::real >, const MaterialStateManager::StorageMode=MaterialStateManager::LOCAL_STORAGE, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE) noexcept
	set the given material property from a modifiable memory region
MGIS_EXPORT bool	mgis::behaviour::unsetMaterialProperty (Context &, MaterialStateManager &, std::string_view) noexcept
	remove the field holder associated with the given material property, if defined
MGIS_EXPORT bool	mgis::behaviour::isMaterialPropertyDefined (const MaterialStateManager &, std::string_view)
MGIS_EXPORT bool	mgis::behaviour::isMaterialPropertyUniform (const MaterialStateManager &, std::string_view)
	chek if the given material property is uniform
MGIS_EXPORT std::optional< bool >	mgis::behaviour::isMaterialPropertyUniform (Context &, const MaterialStateManager &, std::string_view) noexcept
	chek if the given material property is uniform
MGIS_EXPORT void	mgis::behaviour::setMassDensity (MaterialStateManager &, const real, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE) noexcept
	set the mass density
MGIS_EXPORT void	mgis::behaviour::setMassDensity (MaterialStateManager &, std::span< mgis::real >, const MaterialStateManager::StorageMode=MaterialStateManager::LOCAL_STORAGE, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE)
	set the mass density
MGIS_EXPORT bool	mgis::behaviour::isMassDensityDefined (const MaterialStateManager &) noexcept
MGIS_EXPORT bool	mgis::behaviour::isMassDensityUniform (const MaterialStateManager &)
MGIS_EXPORT std::optional< bool >	mgis::behaviour::isMassDensityUniform (Context &, const MaterialStateManager &) noexcept
MGIS_EXPORT void	mgis::behaviour::setExternalStateVariable (MaterialStateManager &, std::string_view, const real, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE)
	set the given external state variable
MGIS_EXPORT void	mgis::behaviour::setExternalStateVariable (MaterialStateManager &, std::string_view, std::span< mgis::real >, const MaterialStateManager::StorageMode=MaterialStateManager::LOCAL_STORAGE, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE)
	set the given external state variable
MGIS_EXPORT bool	mgis::behaviour::setExternalStateVariable (Context &, MaterialStateManager &, std::string_view, const real, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE) noexcept
	set the given external state variable
MGIS_EXPORT bool	mgis::behaviour::setExternalStateVariable (Context &, MaterialStateManager &, std::string_view, std::span< mgis::real >, const MaterialStateManager::StorageMode=MaterialStateManager::LOCAL_STORAGE, const MaterialStateManager::UpdatePolicy=MaterialStateManager::UPDATE) noexcept
	set the given external state variable
MGIS_EXPORT bool	mgis::behaviour::unsetExternalStateVariable (Context &, MaterialStateManager &, std::string_view) noexcept
	remove the field holder associated with the given external state variable, if defined
MGIS_EXPORT bool	mgis::behaviour::isExternalStateVariableDefined (const MaterialStateManager &, std::string_view)
MGIS_EXPORT bool	mgis::behaviour::isExternalStateVariableUniform (const MaterialStateManager &, std::string_view)
MGIS_EXPORT std::optional< bool >	mgis::behaviour::isExternalStateVariableUniform (Context &, const MaterialStateManager &, std::string_view) noexcept
MGIS_EXPORT void	mgis::behaviour::updateValues (MaterialStateManager &, const MaterialStateManager &)
	update the values of a state from another state
MGIS_EXPORT bool	mgis::behaviour::updateValues (Context &, MaterialStateManager &, const MaterialStateManager &) noexcept
	update the values of a state from another state
MGIS_EXPORT void	mgis::behaviour::extractInternalStateVariable (std::span< mgis::real >, const mgis::behaviour::MaterialStateManager &, const std::string_view)
	extract an internal state variable

Detailed Description

Author

Thomas Helfer

Date

05/08/2018

Copyright

(C) Copyright Thomas Helfer 2018. Use, modification and distribution are subject to one of the following licences:

• GNU Lesser General Public License (LGPL), Version 3.0. (See accompanying file LGPL-3.0.txt)
• CECILL-C, Version 1.0 (See accompanying files CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt).

Function Documentation

extractInternalStateVariable()

MGIS_EXPORT void mgis::behaviour::extractInternalStateVariable	(	std::span< mgis::real >	,
		const mgis::behaviour::MaterialStateManager &	,
		const std::string_view
	)

extract an internal state variable

Parameters

[out]	o	buffer in which the values of the given internal state variable is stored
[in]	s	material state manager
[in]	n	name of the internal state variables

Note

the output buffer must be allocated properly

isExternalStateVariableDefined()

MGIS_EXPORT bool mgis::behaviour::isExternalStateVariableDefined	(	const MaterialStateManager &	,
		std::string_view
	)

Returns

true if the given external state variable is defined.

Parameters

	[int]	m: material state manager
[in]	n	name

isExternalStateVariableUniform() [1/2]

MGIS_EXPORT bool mgis::behaviour::isExternalStateVariableUniform	(	const MaterialStateManager &	,
		std::string_view
	)

Returns

true if the given external state variable is uniform.

Parameters

	[int]	m: material state manager
[in]	n	name

isExternalStateVariableUniform() [2/2]

MGIS_EXPORT std::optional< bool > mgis::behaviour::isExternalStateVariableUniform ( Context &  , const MaterialStateManager &  , std::string_view    )

noexcept

Returns

true if the given external state variable is uniform.

Parameters

[in,out]	ctx	execution context
	[int]	m: material state manager
[in]	n	name

isMassDensityDefined()

MGIS_EXPORT bool mgis::behaviour::isMassDensityDefined ( const MaterialStateManager &  )

noexcept

Returns

true if the given external state variable is defined.

Parameters

[out]

m

material state manager

isMassDensityUniform() [1/2]

MGIS_EXPORT bool mgis::behaviour::isMassDensityUniform

(

const MaterialStateManager &

)

Returns

true if the mass density is uniform

Parameters

[in]

m

material state manager

isMassDensityUniform() [2/2]

MGIS_EXPORT std::optional< bool > mgis::behaviour::isMassDensityUniform ( Context &  , const MaterialStateManager &    )

noexcept

Returns

true if the mass density is uniform

Parameters

[in,out]	ctx	execution context
[in]	m	material state manager

isMaterialPropertyDefined()

MGIS_EXPORT bool mgis::behaviour::isMaterialPropertyDefined	(	const MaterialStateManager &	,
		std::string_view
	)

Returns

true if the given external state variable is defined.

Parameters

[in]	m	material state manager
[in]	n	name

isMaterialPropertyUniform() [1/2]

MGIS_EXPORT bool mgis::behaviour::isMaterialPropertyUniform	(	const MaterialStateManager &	,
		std::string_view
	)

chek if the given material property is uniform

Parameters

[in]	m	material state manager
[in]	n	name

isMaterialPropertyUniform() [2/2]

MGIS_EXPORT std::optional< bool > mgis::behaviour::isMaterialPropertyUniform ( Context &  , const MaterialStateManager &  , std::string_view    )

noexcept

chek if the given material property is uniform

Parameters

[in,out]	ctx	execution context
[in]	m	material state manager
[in]	n	name

setExternalStateVariable() [1/4]

MGIS_EXPORT bool mgis::behaviour::setExternalStateVariable ( Context &  , MaterialStateManager &  , std::string_view  , const real  , const MaterialStateManager::UpdatePolicy  = MaterialStateManager::UPDATE  )

noexcept

set the given external state variable

Parameters

[in,out]	ctx	execution context
[out]	m	material state manager
[in]	n	name
[in]	v	value
[in]	p	update policy

setExternalStateVariable() [2/4]

MGIS_EXPORT bool mgis::behaviour::setExternalStateVariable ( Context &  , MaterialStateManager &  , std::string_view  , std::span< mgis::real >  , const MaterialStateManager::StorageMode  = MaterialStateManager::LOCAL_STORAGE, const MaterialStateManager::UpdatePolicy  = MaterialStateManager::UPDATE  )

noexcept

set the given external state variable

set the given external state variable from a non-modifiable memory region

Parameters

[in,out]	ctx	execution context
[out]	m	material state manager
[in]	n	name
[in]	v	values
[in]	s	storage mode
[in]	p	update policy
[in,out]	ctx	execution context
[out]	m	material state manager
[in]	n	name
[in]	v	values
[in]	s	storage mode
[in]	p	update policy

Note

the UpdatePolicy can be set to UPDATE in case of local storage, i.e. the UpdatePolicy must be set to NOUPDATE in case of external storage

setExternalStateVariable() [3/4]

MGIS_EXPORT void mgis::behaviour::setExternalStateVariable	(	MaterialStateManager &	,
		std::string_view	,
		const real	,
		const MaterialStateManager::UpdatePolicy	= MaterialStateManager::UPDATE
	)

set the given external state variable

Parameters

[out]	m	material state manager
[in]	n	name
[in]	v	value
[in]	p	update policy

setExternalStateVariable() [4/4]

MGIS_EXPORT void mgis::behaviour::setExternalStateVariable	(	MaterialStateManager &	,
		std::string_view	,
		std::span< mgis::real >	,
		const MaterialStateManager::StorageMode	= MaterialStateManager::LOCAL_STORAGE,
		const MaterialStateManager::UpdatePolicy	= MaterialStateManager::UPDATE
	)

set the given external state variable

Parameters

[out]	m	material state manager
[in]	n	name
[in]	v	values
[in]	s	storage mode
[in]	p	update policy

setMassDensity() [1/2]

MGIS_EXPORT void mgis::behaviour::setMassDensity ( MaterialStateManager &  , const real  , const MaterialStateManager::UpdatePolicy  = MaterialStateManager::UPDATE  )

noexcept

set the mass density

Parameters

[out]	m	material state manager
[in]	v	value
[in]	p	update policy

setMassDensity() [2/2]

MGIS_EXPORT void mgis::behaviour::setMassDensity	(	MaterialStateManager &	,
		std::span< mgis::real >	,
		const MaterialStateManager::StorageMode	= MaterialStateManager::LOCAL_STORAGE,
		const MaterialStateManager::UpdatePolicy	= MaterialStateManager::UPDATE
	)

set the mass density

Parameters

[in]	m	material state manager
[in]	v	values
[in]	s	storage mode
[in]	p	update policy

setMaterialProperty() [1/4]

MGIS_EXPORT bool mgis::behaviour::setMaterialProperty ( Context &  , MaterialStateManager &  , std::string_view  , const real  , const MaterialStateManager::UpdatePolicy  = MaterialStateManager::UPDATE  )

noexcept

set the given material property

Parameters

[in,out]	ctx	execution context
[out]	m	material state manager
[in]	n	name
[in]	v	value
[in]	p	update policy

setMaterialProperty() [2/4]

MGIS_EXPORT bool mgis::behaviour::setMaterialProperty ( Context &  , MaterialStateManager &  , std::string_view  , std::span< mgis::real >  , const MaterialStateManager::StorageMode  = MaterialStateManager::LOCAL_STORAGE, const MaterialStateManager::UpdatePolicy  = MaterialStateManager::UPDATE  )

noexcept

set the given material property from a modifiable memory region

set the given material property from an immutable memory region

Parameters

[in,out]	ctx	execution context
[out]	m	material state manager
[in]	n	name
[in]	v	values
[in]	s	storage mode
[in]	p	update policy
[in,out]	ctx	execution context
[out]	m	material state manager
[in]	n	name
[in]	v	values
[in]	s	storage mode
[in]	p	update policy

Note

the UpdatePolicy can be set to UPDATE in case of local storage, i.e. the UpdatePolicy must be set to NOUPDATE in case of external storage

setMaterialProperty() [3/4]

MGIS_EXPORT void mgis::behaviour::setMaterialProperty	(	MaterialStateManager &	,
		std::string_view	,
		const real	,
		const MaterialStateManager::UpdatePolicy	= MaterialStateManager::UPDATE
	)

set the given material property

Parameters

[out]	m	material state manager
[in]	n	name
[in]	v	value
[in]	p	update policy

setMaterialProperty() [4/4]

MGIS_EXPORT void mgis::behaviour::setMaterialProperty	(	MaterialStateManager &	,
		std::string_view	,
		std::span< mgis::real >	,
		const MaterialStateManager::StorageMode	= MaterialStateManager::LOCAL_STORAGE,
		const MaterialStateManager::UpdatePolicy	= MaterialStateManager::UPDATE
	)

set the given material property

Parameters

[out]	m	material state manager
[in]	n	name
[in]	v	values
[in]	s	storage mode
[in]	p	update policy

unsetExternalStateVariable()

MGIS_EXPORT bool mgis::behaviour::unsetExternalStateVariable ( Context &  , MaterialStateManager &  , std::string_view    )

noexcept

remove the field holder associated with the given external state variable, if defined

Parameters

[in,out]	ctx	execution context
[out]	m	material state manager
[in]	n	name

unsetMaterialProperty()

MGIS_EXPORT bool mgis::behaviour::unsetMaterialProperty ( Context &  , MaterialStateManager &  , std::string_view    )

noexcept

remove the field holder associated with the given material property, if defined

Parameters

[in,out]	ctx	execution context
[out]	m	material state manager
[in]	n	name

updateValues() [1/2]

MGIS_EXPORT bool mgis::behaviour::updateValues ( Context &  , MaterialStateManager &  , const MaterialStateManager &    )

noexcept

update the values of a state from another state

Parameters

[out]	o	output state
[out]	i	input state

updateValues() [2/2]

MGIS_EXPORT void mgis::behaviour::updateValues	(	MaterialStateManager &	,
		const MaterialStateManager &
	)

update the values of a state from another state

Parameters

[out]	o	output state
[out]	i	input state