MoReFEM::ParameterNS Namespace Reference

Namespace that enclose stuff related to Parameter. More...

Namespaces
namespace	Policy
	Placeholder namespace description needed for it to appear in Doxygen namespace list.
namespace	TimeDependencyNS
	Placeholder namespace description needed for it to appear in Doxygen namespace list.

Data Structures
struct	FromParameterAtDof
	Define a convertor from a ParameterAtDof to a ParameterAtQuadraturePoint. More...
class	GradientBasedElasticityTensor
	Gradient based elasticity tensor. More...
class	LameLambda
	Yields Lame lambda coefficient from Young modulus and Poisson ratio. More...
class	LameMu
	Yields Lame lambda coefficient from Young modulus and Poisson ratio. More...
class	ThreeDimensionalCoumpoundParameter
	Class to handle a 3D parameter (for instance a force). More...

Typedefs
template<ParameterNS::Type TypeT, TIME_MANAGER_TEMPLATE_KEYWORD TimeManagerT>
using	TimeDependencyFunctor
	An instantiation of TimeDependencyNS::Base where the function is given by a mere std::function.
template<ParameterNS::Type TypeT, TIME_MANAGER_TEMPLATE_KEYWORD TimeManagerT>
using	TimeDependencyFromFile = TimeDependencyNS::Base<TypeT, TimeManagerT, TimeDependencyNS::PolicyNS::FromFile>
	An instantiation of TimeDependencyNS::Base where the time dependency policy is FromFile.

Enumerations
enum class	Type { scalar , vector , matrix }
	Type of the parameter to build.
enum class	GradientBasedElasticityTensorConfiguration { dim1 , dim2_plane_stress , dim2_plane_strain , dim3 }
	This enum encompasses the possible configurations to consider in a GradientBasedElasticityTensor.

Functions
template<Type TypeT>
std::string	Name ()
	Returns a name as a string that describes the type considered.
template<::MoReFEM::Advanced::Concept::MoReFEMDataType MoReFEMDataT>
::MoReFEM::ParameterNS::GradientBasedElasticityTensorConfiguration	ReadGradientBasedElasticityTensorConfigurationFromFile (const std::size_t mesh_dimension, const MoReFEMDataT &morefem_data)
	Read the input data file to decide which configuration should be chosen for the GradientBasedElasticityTensor.

Detailed Description

Namespace that enclose stuff related to Parameter.

Typedef Documentation

TimeDependencyFunctor

template<ParameterNS::Type TypeT, TIME_MANAGER_TEMPLATE_KEYWORD TimeManagerT>

using MoReFEM::ParameterNS::TimeDependencyFunctor

Initial value:

 
        TimeDependencyNS::Base<TypeT, TimeManagerT, TimeDependencyNS::PolicyNS::Functor<std::function<double(double)>>>

An instantiation of TimeDependencyNS::Base where the function is given by a mere std::function.

Template Parameters

TypeT

Whether the parameter at a local position yields a scalar, a vector or a matrix.

TimeDependencyFromFile

template<ParameterNS::Type TypeT, TIME_MANAGER_TEMPLATE_KEYWORD TimeManagerT>

using MoReFEM::ParameterNS::TimeDependencyFromFile = TimeDependencyNS::Base<TypeT, TimeManagerT, TimeDependencyNS::PolicyNS::FromFile>

An instantiation of TimeDependencyNS::Base where the time dependency policy is FromFile.

Template Parameters

TypeT

Whether the parameter at a local position yields a scalar, a vector or a matrix.

Function Documentation

Name()

template<Type TypeT>

std::string MoReFEM::ParameterNS::Name

(

)

Returns a name as a string that describes the type considered.

Note

This function is used to populate the field of the Traits class in Parameter library.

Template Parameters

TypeT

Type for which we want a string moniker.

Returns

String moniker associated to TypeT.

ReadGradientBasedElasticityTensorConfigurationFromFile()

template<::MoReFEM::Advanced::Concept::MoReFEMDataType MoReFEMDataT>

::MoReFEM::ParameterNS::GradientBasedElasticityTensorConfiguration MoReFEM::ParameterNS::ReadGradientBasedElasticityTensorConfigurationFromFile	(	const std::size_t	mesh_dimension,
		const MoReFEMDataT &	morefem_data )

Read the input data file to decide which configuration should be chosen for the GradientBasedElasticityTensor.

Parameters

[in]	morefem_data	The object which encapsulates some stuff that acts as global data, such as: The content of the input data. Mpi related information. The directory into which output is to be written. Management of time iterations
[in]	mesh_dimension	DImension of the mesh.

Returns

Enum that specified the configuration to use in the model.