#include <map>
#include <vector>
#include "MGIS/Config.hxx"
#include "MGIS/Behaviour/Hypothesis.hxx"
#include "MGIS/Behaviour/Variable.hxx"

Classes
struct	mgis::behaviour::BehaviourDescription
	structure describing a behaviour More...

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

Functions
MGIS_EXPORT void	mgis::behaviour::loadBehaviourDescription (BehaviourDescription &, const std::string &, const std::string &, const Hypothesis)
	load the description of a behaviour from a library

MGIS_EXPORT mgis::size_type	mgis::behaviour::getTangentOperatorArraySize (const BehaviourDescription &)

MGIS_EXPORT bool	mgis::behaviour::isStandardFiniteStrainBehaviour (const std::string &, const std::string &)

template<typename T >
T	mgis::behaviour::getParameterDefaultValue (const BehaviourDescription &, const std::string &)

template<>
MGIS_EXPORT double	mgis::behaviour::getParameterDefaultValue< double > (const BehaviourDescription &, const std::string &)

template<>
MGIS_EXPORT int	mgis::behaviour::getParameterDefaultValue< int > (const BehaviourDescription &, const std::string &)

template<>
MGIS_EXPORT unsigned short	mgis::behaviour::getParameterDefaultValue< unsigned short > (const BehaviourDescription &, const std::string &)

MGIS_EXPORT bool	mgis::behaviour::hasBounds (const BehaviourDescription &, const std::string &)

MGIS_EXPORT bool	mgis::behaviour::hasLowerBound (const BehaviourDescription &, const std::string &)

MGIS_EXPORT bool	mgis::behaviour::hasUpperBound (const BehaviourDescription &, const std::string &)

MGIS_EXPORT long double	mgis::behaviour::getLowerBound (const BehaviourDescription &, const std::string &)

MGIS_EXPORT long double	mgis::behaviour::getUpperBound (const BehaviourDescription &, const std::string &)

MGIS_EXPORT bool	mgis::behaviour::hasPhysicalBounds (const BehaviourDescription &, const std::string &)

MGIS_EXPORT bool	mgis::behaviour::hasLowerPhysicalBound (const BehaviourDescription &, const std::string &)

MGIS_EXPORT bool	mgis::behaviour::hasUpperPhysicalBound (const BehaviourDescription &, const std::string &)

MGIS_EXPORT long double	mgis::behaviour::getLowerPhysicalBound (const BehaviourDescription &, const std::string &)

MGIS_EXPORT long double	mgis::behaviour::getUpperPhysicalBound (const BehaviourDescription &, const std::string &)

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

MGIS_EXPORT std::vector< Variable >	mgis::behaviour::getBehaviourInitializeFunctionInputs (const std::string &, const std::string &, const std::string &, const Hypothesis)

MGIS_EXPORT std::vector< Variable >	mgis::behaviour::getBehaviourPostProcessingOutputs (const std::string &, const std::string &, const std::string &, const Hypothesis)

Detailed Description

Author: Thomas Helfer

Date: 19/06/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

◆ getBehaviourInitializeFunctionInputs()

MGIS_EXPORT std::vector< Variable > mgis::behaviour::getBehaviourInitializeFunctionInputs	(	const std::string &	,
		const std::string &	,
		const std::string &	,
		const Hypothesis
	)

Returns: the inputs of an initialize function

Parameters

[in]	l	library name
[in]	b	behaviour name
[in]	i	initialize function
[in]	h	modelling hypothesis

◆ getBehaviourPostProcessingOutputs()

MGIS_EXPORT std::vector< Variable > mgis::behaviour::getBehaviourPostProcessingOutputs	(	const std::string &	,
		const std::string &	,
		const std::string &	,
		const Hypothesis
	)

Returns: the outputs of a post-processing functions

Parameters

[in]	l	library name
[in]	b	behaviour name
[in]	i	post-processing
[in]	h	modelling hypothesis

◆ getLowerBound()

MGIS_EXPORT long double mgis::behaviour::getLowerBound	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: the lower bound of the given variable

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ getLowerPhysicalBound()

MGIS_EXPORT long double mgis::behaviour::getLowerPhysicalBound	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: the lower bound of the given variable

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ getParameterDefaultValue()

template<typename T >

T mgis::behaviour::getParameterDefaultValue	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: the default value of a parameter

Parameters

[in]	b	behaviour description
[in]	n	parameter name

◆ getParameterDefaultValue< double >()

template<>

MGIS_EXPORT double mgis::behaviour::getParameterDefaultValue< double >	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: the default value of a parameter

Parameters

[in]	b	behaviour description
[in]	n	parameter name

◆ getParameterDefaultValue< int >()

template<>

MGIS_EXPORT int mgis::behaviour::getParameterDefaultValue< int >	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: the default value of a parameter

Parameters

[in]	b	behaviour description
[in]	n	parameter name

◆ getParameterDefaultValue< unsigned short >()

template<>

MGIS_EXPORT unsigned short mgis::behaviour::getParameterDefaultValue< unsigned short >	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: the default value of a parameter

Parameters

[in]	b	behaviour description
[in]	n	parameter name

◆ getTangentOperatorArraySize()

MGIS_EXPORT mgis::size_type mgis::behaviour::getTangentOperatorArraySize ( const BehaviourDescription & )

Returns: the size of an array able to contain all the values of the tangent operator

Parameters

[in] b behaviour

◆ getUpperBound()

MGIS_EXPORT long double mgis::behaviour::getUpperBound	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: the upper bound of the given variable

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ getUpperPhysicalBound()

MGIS_EXPORT long double mgis::behaviour::getUpperPhysicalBound	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: the upper bound of the given variable

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ hasBounds()

MGIS_EXPORT bool mgis::behaviour::hasBounds	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: true if the given variable has bounds

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ hasLowerBound()

MGIS_EXPORT bool mgis::behaviour::hasLowerBound	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: true if the given variable has a lower bound

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ hasLowerPhysicalBound()

MGIS_EXPORT bool mgis::behaviour::hasLowerPhysicalBound	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: true if the given variable has a lower physical bound

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ hasPhysicalBounds()

MGIS_EXPORT bool mgis::behaviour::hasPhysicalBounds	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: true if the given variable has bounds

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ hasUpperBound()

MGIS_EXPORT bool mgis::behaviour::hasUpperBound	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: true if the given variable has a upper bound

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ hasUpperPhysicalBound()

MGIS_EXPORT bool mgis::behaviour::hasUpperPhysicalBound	(	const BehaviourDescription &	,
		const std::string &
	)

Returns: true if the given variable has a upper physical bound

Parameters

[in]	b	behaviour
[in]	v	variable name

◆ isStandardFiniteStrainBehaviour()

MGIS_EXPORT bool mgis::behaviour::isStandardFiniteStrainBehaviour	(	const std::string &	,
		const std::string &
	)

Returns: if the given behaviour is a standard finite strain behaviour, i.e. is a finite strain behaviour using the standard finite strain kinematic (called F-Cauchy although the stress measure can be chosen when loading the behaviour)

Parameters

[in]	l	library name
[in]	b	behaviour name

Note: : use of std::string rather than mgis::string_view is meaningfull here

◆ loadBehaviourDescription()

MGIS_EXPORT void mgis::behaviour::loadBehaviourDescription	(	BehaviourDescription &	,
		const std::string &	,
		const std::string &	,
		const Hypothesis
	)

load the description of a behaviour from a library

Parameters

[out]	d	behaviour description
[in]	l	library name
[in]	b	behaviour name
[in]	h	modelling hypothesis

Returns: the behaviour description

Note: : use of std::string rather than mgis::string_view is meaningfull here

◆ print_markdown()

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

print a detailled (verbose) description of the behaviour using a markdown format

Parameters

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

Classes

Namespaces

Functions

Detailed Description

Function Documentation

◆ getBehaviourInitializeFunctionInputs()

◆ getBehaviourPostProcessingOutputs()

◆ getLowerBound()

◆ getLowerPhysicalBound()

◆ getParameterDefaultValue()

◆ getParameterDefaultValue< double >()

◆ getParameterDefaultValue< int >()

◆ getParameterDefaultValue< unsigned short >()

◆ getTangentOperatorArraySize()

◆ getUpperBound()

◆ getUpperPhysicalBound()

◆ hasBounds()

◆ hasLowerBound()

◆ hasLowerPhysicalBound()

◆ hasPhysicalBounds()

◆ hasUpperBound()

◆ hasUpperPhysicalBound()

◆ isStandardFiniteStrainBehaviour()

◆ loadBehaviourDescription()

◆ print_markdown()