#include <span>
#include <iosfwd>
#include <vector>
#include <string_view>
#include "MGIS/Config.hxx"
#include "MGIS/Behaviour/StateView.hxx"
#include "MGIS/Behaviour/State.ixx"

Classes
struct	mgis::behaviour::State
	structure in charge of containing the state of a material. More...

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

Functions
MGIS_EXPORT void	mgis::behaviour::setGradient (State &, const std::string_view, const real)
	set the value of a gradient

MGIS_EXPORT void	mgis::behaviour::setGradient (State &, const std::string_view, const real *const)
	set the value of a gradient

MGIS_EXPORT void	mgis::behaviour::setGradient (State &, const size_type, const real)
	set the value of a gradient

MGIS_EXPORT void	mgis::behaviour::setGradient (State &, const size_type, const size_type, const real)
	set the value of a gradient

MGIS_EXPORT void	mgis::behaviour::setGradient (State &, const size_type, const size_type, const real *const)
	set the values of a gradient

MGIS_EXPORT real *	mgis::behaviour::getGradient (State &, const std::string_view)
	get the value(s) of a gradient

MGIS_EXPORT const real *	mgis::behaviour::getGradient (const State &, const std::string_view)
	get the value(s) of a gradient

MGIS_EXPORT real *	mgis::behaviour::getGradient (State &, const size_type)
	get the value(s) of a gradient

MGIS_EXPORT const real *	mgis::behaviour::getGradient (const State &, const size_type)
	get the value(s) of a gradient

MGIS_EXPORT void	mgis::behaviour::setThermodynamicForce (State &, const std::string_view, const real)
	set the value of a thermodynamic force

MGIS_EXPORT void	mgis::behaviour::setThermodynamicForce (State &, const std::string_view, const real *const)
	set the value of a thermodynamic force

MGIS_EXPORT void	mgis::behaviour::setThermodynamicForce (State &, const size_type, const real)
	set the value of a thermodynamic force

MGIS_EXPORT void	mgis::behaviour::setThermodynamicForce (State &, const size_type, const size_type, const real)
	set the value of a thermodynamic force

MGIS_EXPORT void	mgis::behaviour::setThermodynamicForce (State &, const size_type, const size_type, const real *const)
	set the values of a thermodynamic force

MGIS_EXPORT real *	mgis::behaviour::getThermodynamicForce (State &, const std::string_view)
	get the value(s) of a thermodynamic force

MGIS_EXPORT const real *	mgis::behaviour::getThermodynamicForce (const State &, const std::string_view)
	get the value(s) of a thermodynamic force

MGIS_EXPORT real *	mgis::behaviour::getThermodynamicForce (State &, const size_type)
	get the value(s) of a thermodynamic force

MGIS_EXPORT const real *	mgis::behaviour::getThermodynamicForce (const State &, const size_type)
	get the value(s) of a thermodynamic force

MGIS_EXPORT void	mgis::behaviour::setMaterialProperty (State &, const std::string_view, const real)
	set the value of a material property

MGIS_EXPORT real *	mgis::behaviour::getMaterialProperty (State &, const std::string_view)

MGIS_EXPORT const real *	mgis::behaviour::getMaterialProperty (const State &, const std::string_view)

MGIS_EXPORT void	mgis::behaviour::setMaterialProperty (State &, const size_type, const real)
	set the value of a material property

MGIS_EXPORT real *	mgis::behaviour::getMaterialProperty (State &, const size_type)

MGIS_EXPORT const real *	mgis::behaviour::getMaterialProperty (const State &, const size_type)

MGIS_EXPORT void	mgis::behaviour::setInternalStateVariable (State &, const std::string_view, const real)
	set the value of an internal state variable

MGIS_EXPORT void	mgis::behaviour::setInternalStateVariable (State &, const std::string_view, const real *const)
	set the value of an internal state variable

MGIS_EXPORT void	mgis::behaviour::setInternalStateVariable (State &, const size_type, const real)
	set the value of an internal state variable

MGIS_EXPORT void	mgis::behaviour::setInternalStateVariable (State &, const size_type, const size_type, const real)
	set the value of an internal state variable

MGIS_EXPORT void	mgis::behaviour::setInternalStateVariable (State &, const size_type, const size_type, const real *const)
	set the values of an internal state variable

MGIS_EXPORT real *	mgis::behaviour::getInternalStateVariable (State &, const std::string_view)
	get the value(s) of an internal state variable

MGIS_EXPORT const real *	mgis::behaviour::getInternalStateVariable (const State &, const std::string_view)
	get the value(s) of an internal state variable

MGIS_EXPORT real *	mgis::behaviour::getInternalStateVariable (State &, const size_type)
	get the value(s) of an internal state variable

MGIS_EXPORT const real *	mgis::behaviour::getInternalStateVariable (const State &, const size_type)
	get the value(s) of an internal state variable

MGIS_EXPORT void	mgis::behaviour::setExternalStateVariable (State &, const std::string_view, const real)
	set the value of a scalar external state variable

MGIS_EXPORT void	mgis::behaviour::setExternalStateVariable (State &, const std::string_view, const std::span< const real >)
	set the value of an external state variable

MGIS_EXPORT void	mgis::behaviour::setExternalStateVariable (State &, const size_type, const real)
	set the value of a scalar external state variable

MGIS_EXPORT void	mgis::behaviour::setExternalStateVariable (State &, const size_type, const std::span< const real >)
	set the value of an external state variable

MGIS_EXPORT real *	mgis::behaviour::getExternalStateVariable (State &, const std::string_view)
	set the value of an external state variable

MGIS_EXPORT const real *	mgis::behaviour::getExternalStateVariable (const State &, const std::string_view)
	set the value of an external state variable

MGIS_EXPORT real *	mgis::behaviour::getExternalStateVariable (State &, const size_type)

MGIS_EXPORT const real *	mgis::behaviour::getExternalStateVariable (const State &, const size_type)

StateView	mgis::behaviour::make_view (State &)
	make a view from a behaviour data

InitialStateView	mgis::behaviour::make_view (const State &)
	make a view from a behaviour data

MGIS_EXPORT void	mgis::behaviour::print_markdown (std::ostream &, const Behaviour &, const State &, const mgis::size_type)
	print a detailled (verbose) description of the integration point state using a markdown format

Detailed Description

Author: Thomas Helfer

Date: 02/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

◆ getExternalStateVariable() [1/4]

MGIS_EXPORT const real * mgis::behaviour::getExternalStateVariable	(	const State &	,
		const size_type
	)

Returns: a pointer to the value of an external state variable

Parameters

[out]	s	state
[in]	o	external state variable offset

◆ getExternalStateVariable() [2/4]

MGIS_EXPORT const real * mgis::behaviour::getExternalStateVariable	(	const State &	,
		const std::string_view
	)

set the value of an external state variable

Parameters

[out]	s	state
[in]	n	name

◆ getExternalStateVariable() [3/4]

MGIS_EXPORT real * mgis::behaviour::getExternalStateVariable	(	State &	,
		const size_type
	)

Returns: a pointer to the value of an external state variable

Parameters

[out]	s	state
[in]	o	external state variable offset

◆ getExternalStateVariable() [4/4]

MGIS_EXPORT real * mgis::behaviour::getExternalStateVariable	(	State &	,
		const std::string_view
	)

set the value of an external state variable

Parameters

[out]	s	state
[in]	n	name

◆ getGradient() [1/4]

MGIS_EXPORT const real * mgis::behaviour::getGradient	(	const State &	,
		const size_type
	)

get the value(s) of a gradient

Returns: a pointer the value(s) of the gradient

Parameters

[in]	s	state
[in]	o	gradient offset

◆ getGradient() [2/4]

MGIS_EXPORT const real * mgis::behaviour::getGradient	(	const State &	,
		const std::string_view
	)

get the value(s) of a gradient

Returns: a pointer the value(s) of the gradient

Parameters

[in]	s	state
[in]	n	name

◆ getGradient() [3/4]

MGIS_EXPORT real * mgis::behaviour::getGradient	(	State &	,
		const size_type
	)

get the value(s) of a gradient

Returns: a pointer the value(s) of the gradient

Parameters

[in]	s	state
[in]	o	gradient offset

◆ getGradient() [4/4]

MGIS_EXPORT real * mgis::behaviour::getGradient	(	State &	,
		const std::string_view
	)

get the value(s) of a gradient

Returns: a pointer the value(s) of the gradient

Parameters

[in]	s	state
[in]	n	name

◆ getInternalStateVariable() [1/4]

MGIS_EXPORT const real * mgis::behaviour::getInternalStateVariable	(	const State &	,
		const size_type
	)

get the value(s) of an internal state variable

Returns: a pointer the value(s) of the internal state variable

Parameters

[in]	s	state
[in]	o	internal state variable offset

◆ getInternalStateVariable() [2/4]

MGIS_EXPORT const real * mgis::behaviour::getInternalStateVariable	(	const State &	,
		const std::string_view
	)

get the value(s) of an internal state variable

Returns: a pointer the value(s) of the internal state variable

Parameters

[in]	s	state
[in]	n	name

◆ getInternalStateVariable() [3/4]

MGIS_EXPORT real * mgis::behaviour::getInternalStateVariable	(	State &	,
		const size_type
	)

get the value(s) of an internal state variable

Returns: a pointer the value(s) of the internal state variable

Parameters

[in]	s	state
[in]	o	internal state variable offset

◆ getInternalStateVariable() [4/4]

MGIS_EXPORT real * mgis::behaviour::getInternalStateVariable	(	State &	,
		const std::string_view
	)

get the value(s) of an internal state variable

Returns: a pointer the value(s) of the internal state variable

Parameters

[in]	s	state
[in]	n	name

◆ getMaterialProperty() [1/4]

MGIS_EXPORT const real * mgis::behaviour::getMaterialProperty	(	const State &	,
		const size_type
	)

Returns: a pointer to the value of a material property

Parameters

[out]	s	state
[in]	o	material property offset

◆ getMaterialProperty() [2/4]

MGIS_EXPORT const real * mgis::behaviour::getMaterialProperty	(	const State &	,
		const std::string_view
	)

Returns: a pointer to the value of a material property

Parameters

[in]	s	state
[in]	n	name

◆ getMaterialProperty() [3/4]

MGIS_EXPORT real * mgis::behaviour::getMaterialProperty	(	State &	,
		const size_type
	)

Returns: a pointer to the value of a material property

Parameters

[out]	s	state
[in]	o	material property offset

◆ getMaterialProperty() [4/4]

MGIS_EXPORT real * mgis::behaviour::getMaterialProperty	(	State &	,
		const std::string_view
	)

Returns: a pointer to the value of a material property

Parameters

[in]	s	state
[in]	n	name

◆ getThermodynamicForce() [1/4]

MGIS_EXPORT const real * mgis::behaviour::getThermodynamicForce	(	const State &	,
		const size_type
	)

get the value(s) of a thermodynamic force

Returns: a pointer the value(s) of the thermodynamic force

Parameters

[in]	s	state
[in]	o	thermodynamic force offset

◆ getThermodynamicForce() [2/4]

MGIS_EXPORT const real * mgis::behaviour::getThermodynamicForce	(	const State &	,
		const std::string_view
	)

get the value(s) of a thermodynamic force

Returns: a pointer the value(s) of the thermodynamic force

Parameters

[in]	s	state
[in]	n	name

◆ getThermodynamicForce() [3/4]

MGIS_EXPORT real * mgis::behaviour::getThermodynamicForce	(	State &	,
		const size_type
	)

get the value(s) of a thermodynamic force

Returns: a pointer the value(s) of the thermodynamic force

Parameters

[in]	s	state
[in]	o	thermodynamic force offset

◆ getThermodynamicForce() [4/4]

MGIS_EXPORT real * mgis::behaviour::getThermodynamicForce	(	State &	,
		const std::string_view
	)

get the value(s) of a thermodynamic force

Returns: a pointer the value(s) of the thermodynamic force

Parameters

[in]	s	state
[in]	n	name

◆ make_view() [1/2]

InitialStateView mgis::behaviour::make_view ( const State & s )

inline

make a view from a behaviour data

Parameters

[in] s state

Returns: the view

Note: the view has at most the same life time as the state.

◆ make_view() [2/2]

StateView mgis::behaviour::make_view ( State & s )

inline

make a view from a behaviour data

Parameters

[in] s state

Returns: the view

Note: the view has at most the same life time as the state.

◆ print_markdown()

MGIS_EXPORT void mgis::behaviour::print_markdown	(	std::ostream &	,
		const Behaviour &	,
		const State &	,
		const mgis::size_type
	)

print a detailled (verbose) description of the integration point state using a markdown format

Parameters

[in]	os	ouptut stream
[in]	b	behaviour
[in]	s	state
[in]	l	title level

◆ setExternalStateVariable() [1/4]

MGIS_EXPORT void mgis::behaviour::setExternalStateVariable	(	State &	,
		const size_type	,
		const real
	)

set the value of a scalar external state variable

Parameters

[out]	s	state
[in]	o	external state variable offset
[in]	v	value

◆ setExternalStateVariable() [2/4]

MGIS_EXPORT void mgis::behaviour::setExternalStateVariable	(	State &	,
		const size_type	,
		const std::span< const real >
	)

set the value of an external state variable

Parameters

[out]	s	state
[in]	o	external state variable offset
[in]	v	value

◆ setExternalStateVariable() [3/4]

MGIS_EXPORT void mgis::behaviour::setExternalStateVariable	(	State &	,
		const std::string_view	,
		const real
	)

set the value of a scalar external state variable

Parameters

[out]	s	state
[in]	n	name
[in]	v	value

◆ setExternalStateVariable() [4/4]

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

set the value of an external state variable

Parameters

[out]	s	state
[in]	n	name
[in]	v	value

◆ setGradient() [1/5]

MGIS_EXPORT void mgis::behaviour::setGradient	(	State &	,
		const size_type	,
		const real
	)

set the value of a gradient

Parameters

[out]	s	state
[in]	o	gradient offset
[in]	v	value

◆ setGradient() [2/5]

MGIS_EXPORT void mgis::behaviour::setGradient	(	State &	,
		const size_type	,
		const size_type	,
		const real * const
	)

set the values of a gradient

Parameters

[out]	s	state
[in]	o	gradient offset
[in]	n	gradient size
[in]	v	values

◆ setGradient() [3/5]

MGIS_EXPORT void mgis::behaviour::setGradient	(	State &	,
		const size_type	,
		const size_type	,
		const real
	)

set the value of a gradient

Parameters

[out]	s	state
[in]	o	gradient offset
[in]	n	gradient size
[in]	v	value

◆ setGradient() [4/5]

MGIS_EXPORT void mgis::behaviour::setGradient	(	State &	,
		const std::string_view	,
		const real * const
	)

set the value of a gradient

Parameters

[out]	s	state
[in]	n	name
[in]	v	values

◆ setGradient() [5/5]

MGIS_EXPORT void mgis::behaviour::setGradient	(	State &	,
		const std::string_view	,
		const real
	)

set the value of a gradient

Parameters

[out]	s	state
[in]	n	name
[in]	v	value

◆ setInternalStateVariable() [1/5]

MGIS_EXPORT void mgis::behaviour::setInternalStateVariable	(	State &	,
		const size_type	,
		const real
	)

set the value of an internal state variable

Parameters

[out]	s	state
[in]	o	internal state variable offset
[in]	v	value

◆ setInternalStateVariable() [2/5]

MGIS_EXPORT void mgis::behaviour::setInternalStateVariable	(	State &	,
		const size_type	,
		const size_type	,
		const real * const
	)

set the values of an internal state variable

Parameters

[out]	s	state
[in]	o	internal state variable offset
[in]	n	internal state variable size
[in]	v	values

◆ setInternalStateVariable() [3/5]

MGIS_EXPORT void mgis::behaviour::setInternalStateVariable	(	State &	,
		const size_type	,
		const size_type	,
		const real
	)

set the value of an internal state variable

Parameters

[out]	s	state
[in]	o	internal state variable offset
[in]	n	internal state variable size
[in]	v	value

◆ setInternalStateVariable() [4/5]

MGIS_EXPORT void mgis::behaviour::setInternalStateVariable	(	State &	,
		const std::string_view	,
		const real * const
	)

set the value of an internal state variable

Parameters

[out]	s	state
[in]	n	name
[in]	v	values

◆ setInternalStateVariable() [5/5]

MGIS_EXPORT void mgis::behaviour::setInternalStateVariable	(	State &	,
		const std::string_view	,
		const real
	)

set the value of an internal state variable

Parameters

[out]	s	state
[in]	n	name
[in]	v	value

◆ setMaterialProperty() [1/2]

MGIS_EXPORT void mgis::behaviour::setMaterialProperty	(	State &	,
		const size_type	,
		const real
	)

set the value of a material property

Parameters

[out]	s	state
[in]	o	material property offset
[in]	v	value

◆ setMaterialProperty() [2/2]

MGIS_EXPORT void mgis::behaviour::setMaterialProperty	(	State &	,
		const std::string_view	,
		const real
	)

set the value of a material property

Parameters

[out]	s	state
[in]	n	name
[in]	v	value

◆ setThermodynamicForce() [1/5]

MGIS_EXPORT void mgis::behaviour::setThermodynamicForce	(	State &	,
		const size_type	,
		const real
	)

set the value of a thermodynamic force

Parameters

[out]	s	state
[in]	o	thermodynamic force offset
[in]	v	value

◆ setThermodynamicForce() [2/5]

MGIS_EXPORT void mgis::behaviour::setThermodynamicForce	(	State &	,
		const size_type	,
		const size_type	,
		const real * const
	)

set the values of a thermodynamic force

Parameters

[out]	s	state
[in]	o	thermodynamic force offset
[in]	n	thermodynamic force size
[in]	v	values

◆ setThermodynamicForce() [3/5]

MGIS_EXPORT void mgis::behaviour::setThermodynamicForce	(	State &	,
		const size_type	,
		const size_type	,
		const real
	)

set the value of a thermodynamic force

Parameters

[out]	s	state
[in]	o	thermodynamic force offset
[in]	n	thermodynamic force size
[in]	v	value

◆ setThermodynamicForce() [4/5]

MGIS_EXPORT void mgis::behaviour::setThermodynamicForce	(	State &	,
		const std::string_view	,
		const real * const
	)

set the value of a thermodynamic force

Parameters

[out]	s	state
[in]	n	name
[in]	v	values

◆ setThermodynamicForce() [5/5]

MGIS_EXPORT void mgis::behaviour::setThermodynamicForce	(	State &	,
		const std::string_view	,
		const real
	)

set the value of a thermodynamic force

Parameters

[out]	s	state
[in]	n	name
[in]	v	value

Classes

Namespaces

Functions

Detailed Description

Function Documentation

◆ getExternalStateVariable() [1/4]

◆ getExternalStateVariable() [2/4]

◆ getExternalStateVariable() [3/4]

◆ getExternalStateVariable() [4/4]

◆ getGradient() [1/4]

◆ getGradient() [2/4]

◆ getGradient() [3/4]

◆ getGradient() [4/4]

◆ getInternalStateVariable() [1/4]

◆ getInternalStateVariable() [2/4]

◆ getInternalStateVariable() [3/4]

◆ getInternalStateVariable() [4/4]

◆ getMaterialProperty() [1/4]

◆ getMaterialProperty() [2/4]

◆ getMaterialProperty() [3/4]

◆ getMaterialProperty() [4/4]

◆ getThermodynamicForce() [1/4]

◆ getThermodynamicForce() [2/4]

◆ getThermodynamicForce() [3/4]

◆ getThermodynamicForce() [4/4]

◆ make_view() [1/2]

◆ make_view() [2/2]

◆ print_markdown()

◆ setExternalStateVariable() [1/4]

◆ setExternalStateVariable() [2/4]

◆ setExternalStateVariable() [3/4]

◆ setExternalStateVariable() [4/4]

◆ setGradient() [1/5]

◆ setGradient() [2/5]

◆ setGradient() [3/5]

◆ setGradient() [4/5]

◆ setGradient() [5/5]

◆ setInternalStateVariable() [1/5]

◆ setInternalStateVariable() [2/5]

◆ setInternalStateVariable() [3/5]

◆ setInternalStateVariable() [4/5]

◆ setInternalStateVariable() [5/5]

◆ setMaterialProperty() [1/2]

◆ setMaterialProperty() [2/2]

◆ setThermodynamicForce() [1/5]

◆ setThermodynamicForce() [2/5]

◆ setThermodynamicForce() [3/5]

◆ setThermodynamicForce() [4/5]

◆ setThermodynamicForce() [5/5]