Model.hxx File Reference

#include "MGIS/Config.hxx"
#include "MGIS/Behaviour/Behaviour.hxx"

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

Typedefs
using	mgis::model::Model = mgis::behaviour::Behaviour
	a simple alias

Functions
MGIS_EXPORT Model	mgis::model::load (const std::string &, const std::string &, const mgis::behaviour::Hypothesis)
	load the description of a model from a library
MGIS_EXPORT std::optional< Model >	mgis::model::load (Context &, const std::string &, const std::string &, const mgis::behaviour::Hypothesis) noexcept
	load the description of a model from a library
MGIS_EXPORT Model	mgis::model::loadFromDatabase (const mgis::behaviour::LoadFromDatabaseOptions &)
	load a model from the database
MGIS_EXPORT std::optional< Model >	mgis::model::loadFromDatabase (Context &, const mgis::behaviour::LoadFromDatabaseOptions &) noexcept
	load a model from the database

Detailed Description

Author

Thomas Helfer

Date

14/10/2021

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).

Typedef Documentation

Model

using mgis::model::Model = typedef mgis::behaviour::Behaviour

a simple alias

In MGIS, a model is a behaviour without gradients, thermodynamic forces nor tangent operator blocks.

Function Documentation

load() [1/2]

MGIS_EXPORT Model mgis::model::load	(	const std::string &	,
		const std::string &	,
		const mgis::behaviour::Hypothesis
	)

load the description of a model from a library

Parameters

[in]	l	library name
[in]	m	model name
[in]	h	modelling hypothesis

Returns

the model description

Note

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

load() [2/2]

MGIS_EXPORT std::optional< Model > mgis::model::load ( Context &  , const std::string &  , const std::string &  , const mgis::behaviour::Hypothesis    )

noexcept

load the description of a model from a library

Parameters

[in]	l	library name
[in]	m	model name
[in]	h	modelling hypothesis

Returns

the model description

Note

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

loadFromDatabase() [1/2]

MGIS_EXPORT Model mgis::model::loadFromDatabase

(

const mgis::behaviour::LoadFromDatabaseOptions &

)

load a model from the database

Returns

the model description

loadFromDatabase() [2/2]

MGIS_EXPORT std::optional< Model > mgis::model::loadFromDatabase ( Context &  , const mgis::behaviour::LoadFromDatabaseOptions &    )

noexcept

load a model from the database

Parameters

[in]	ctx	execution context
[in]	opts	options to select the model

Returns

the model description