Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup Struct Reference

A struct that represents the setup of a part. More...

Collaboration diagram for Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup:

Public Member Functions
std::string const &	filename () const
	Returns the filename of the part. More...
bool	hasExpr () const
	Returns whether the part has a model expression. More...
ModelMarkers const &	markers () const
	Returns the markers of the part. More...
ModelExpression const &	mExpr () const
	Returns the model expression of the part. More...
	PartSetup ()=default
	Default constructor.
std::string const &	spaceFilename () const noexcept
	Returns the filename of function space mapping linked to the file stored as filename attribute. More...

Static Public Member Functions
static std::optional< PartSetup >	create (ModelMeshes< IndexType > const &mMeshes, nl::json const &jarg)
	Creates a new PartSetup object from the given model meshes and JSON data. More...

Detailed Description

template<typename IndexType>
struct Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup

A struct that represents the setup of a part.

This struct contains information about the filename, model expression, and markers of a part.

Member Function Documentation

create()

template<typename IndexType >

std::optional< typename ModelMesh< IndexType >::FieldsSetup::PartSetup > Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup::create ( ModelMeshes< IndexType > const &  mMeshes, nl::json const &  jarg  )

static

Creates a new PartSetup object from the given model meshes and JSON data.

Parameters

mMeshes	The model meshes object.
jarg	The JSON data.

Returns

An optional PartSetup object if successful, std::nullopt otherwise.

References nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::at(), and nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::contains().

filename()

template<typename IndexType >

std::string const & Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup::filename

(

)

const

Returns the filename of the part.

Returns

A reference to the filename string.

hasExpr()

template<typename IndexType >

bool Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup::hasExpr

(

)

const

Returns whether the part has a model expression.

Returns

True if the part has a model expression, false otherwise.

markers()

template<typename IndexType >

ModelMarkers const & Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup::markers

(

)

const

Returns the markers of the part.

Returns

A reference to the model markers object.

mExpr()

template<typename IndexType >

ModelExpression const & Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup::mExpr

(

)

const

Returns the model expression of the part.

Returns

A reference to the model expression object.

spaceFilename()

template<typename IndexType >

std::string const & Feel::FeelModels::ModelMesh< IndexType >::FieldsSetup::PartSetup::spaceFilename ( ) const

noexcept

Returns the filename of function space mapping linked to the file stored as filename attribute.

Returns

A reference to the space filename string.