NeoN::finiteVolume::cellCentred::DomainMixin< ValueType > Class Template Reference

This class represents a mixin for a geometric field. More...

#include <domain.hpp>

Inheritance diagram for NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >:

Public Types
typedef ValueType	ElementType

Public Member Functions
	DomainMixin (const Executor &exec, std::string fieldName, const UnstructuredMesh &mesh, const Field< ValueType > &field)
	Constructor for DomainMixin.
	DomainMixin (const Executor &exec, std::string fieldName, const UnstructuredMesh &mesh, const Vector< ValueType > &internalVector, const BoundaryData< ValueType > &boundaryVectors)
	Constructor for DomainMixin.
const Vector< ValueType > &	internalVector () const
	Returns a const reference to the internal field.
Vector< ValueType > &	internalVector ()
	Returns a reference to the internal field.
localIdx	size () const
	Returns the size of the internal field.
const BoundaryData< ValueType > &	boundaryData () const
	Returns a const reference to the boundary field.
BoundaryData< ValueType > &	boundaryData ()
	Returns a reference to the boundary field.
const Executor &	exec () const
	Returns a const reference to the executor object.
const UnstructuredMesh &	mesh () const
	Returns a const reference to the unstructured mesh object.

Public Attributes
std::string	name

Protected Attributes
Executor	exec_
const UnstructuredMesh &	mesh_
Field< ValueType >	field_

Detailed Description

template<typename ValueType>
class NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >

This class represents a mixin for a geometric field.

The DomainMixin class provides a set of common operations and accessors for a geometric field. It is designed to be used as a mixin in other classes that require geometric field functionality.

Template Parameters

ValueType

The value type of the field.

Definition at line 27 of file domain.hpp.

Member Typedef Documentation

ElementType

template<typename ValueType >

typedef ValueType NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::ElementType

Definition at line 32 of file domain.hpp.

Constructor & Destructor Documentation

DomainMixin() [1/2]

template<typename ValueType >

NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::DomainMixin ( const Executor &  exec, std::string  fieldName, const UnstructuredMesh &  mesh, const Field< ValueType > &  field  )

inline

Constructor for DomainMixin.

Parameters

exec	The executor object.
fieldName	The name of the field.
mesh	The unstructured mesh object.
domainVector	The domain field object.

Definition at line 42 of file domain.hpp.

DomainMixin() [2/2]

template<typename ValueType >

NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::DomainMixin ( const Executor &  exec, std::string  fieldName, const UnstructuredMesh &  mesh, const Vector< ValueType > &  internalVector, const BoundaryData< ValueType > &  boundaryVectors  )

inline

Constructor for DomainMixin.

Parameters

exec	The executor object.
fieldName	The name of the corresponding field.
mesh	The unstructured mesh object.
internalVector	The internal field object.
boundaryVectors	The boundary field object.

Definition at line 60 of file domain.hpp.

Member Function Documentation

boundaryData() [1/2]

template<typename ValueType >

BoundaryData< ValueType > & NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::boundaryData ( )

inline

Returns a reference to the boundary field.

Returns

The reference to the boundary field.

Definition at line 108 of file domain.hpp.

boundaryData() [2/2]

template<typename ValueType >

const BoundaryData< ValueType > & NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::boundaryData ( ) const

inline

Returns a const reference to the boundary field.

Returns

The const reference to the boundary field.

Definition at line 101 of file domain.hpp.

exec()

template<typename ValueType >

const Executor & NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::exec ( ) const

inline

Returns a const reference to the executor object.

Returns

The const reference to the executor object.

Definition at line 115 of file domain.hpp.

internalVector() [1/2]

template<typename ValueType >

Vector< ValueType > & NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::internalVector ( )

inline

Returns a reference to the internal field.

Returns

The reference to the internal field.

Definition at line 87 of file domain.hpp.

internalVector() [2/2]

template<typename ValueType >

const Vector< ValueType > & NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::internalVector ( ) const

inline

Returns a const reference to the internal field.

Returns

The const reference to the internal field.

Definition at line 80 of file domain.hpp.

mesh()

template<typename ValueType >

const UnstructuredMesh & NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::mesh ( ) const

inline

Returns a const reference to the unstructured mesh object.

Returns

The const reference to the unstructured mesh object.

Definition at line 122 of file domain.hpp.

size()

template<typename ValueType >

localIdx NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::size ( ) const

inline

Returns the size of the internal field.

Returns

The size of the internal field

Definition at line 94 of file domain.hpp.

Member Data Documentation

exec_

template<typename ValueType >

Executor NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::exec_

protected

Definition at line 128 of file domain.hpp.

field_

template<typename ValueType >

Field<ValueType> NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::field_

protected

Definition at line 130 of file domain.hpp.

mesh_

template<typename ValueType >

const UnstructuredMesh& NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::mesh_

protected

Definition at line 129 of file domain.hpp.

name

template<typename ValueType >

std::string NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >::name

Definition at line 124 of file domain.hpp.

---

The documentation for this class was generated from the following file:

• /home/runner/work/NeoN/NeoN/include/NeoN/finiteVolume/cellCentred/fields/domain.hpp