NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType > Class Template Reference

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

#include <geometricField.hpp>

Inheritance diagram for NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >:

Public Member Functions
	GeometricFieldMixin (const Executor &exec, std::string fieldName, const UnstructuredMesh &mesh, const DomainField< ValueType > &field)
	Constructor for GeometricFieldMixin.
	GeometricFieldMixin (const Executor &exec, std::string fieldName, const UnstructuredMesh &mesh, const Field< ValueType > &internalField, const BoundaryFields< ValueType > &boundaryFields)
	Constructor for GeometricFieldMixin.
const Field< ValueType > &	internalField () const
	Returns a const reference to the internal field.
Field< ValueType > &	internalField ()
	Returns a reference to the internal field.
size_t	size () const
	Returns the size of the internal field.
const BoundaryFields< ValueType > &	boundaryField () const
	Returns a const reference to the boundary field.
BoundaryFields< ValueType > &	boundaryField ()
	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_
DomainField< ValueType >	field_

Detailed Description

template<typename ValueType>
class NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >

This class represents a mixin for a geometric field.

The GeometricFieldMixin 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 26 of file geometricField.hpp.

Constructor & Destructor Documentation

GeometricFieldMixin() [1/2]

template<typename ValueType >

NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::GeometricFieldMixin ( const Executor &  exec, std::string  fieldName, const UnstructuredMesh &  mesh, const DomainField< ValueType > &  field  )

inline

Constructor for GeometricFieldMixin.

Parameters

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

Definition at line 38 of file geometricField.hpp.

GeometricFieldMixin() [2/2]

template<typename ValueType >

NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::GeometricFieldMixin ( const Executor &  exec, std::string  fieldName, const UnstructuredMesh &  mesh, const Field< ValueType > &  internalField, const BoundaryFields< ValueType > &  boundaryFields  )

inline

Constructor for GeometricFieldMixin.

Parameters

exec	The executor object.
fieldName	The name of the corresponding field.
mesh	The unstructured mesh object.
internalField	The internal field object.
boundaryFields	The boundary field object.

Definition at line 56 of file geometricField.hpp.

Member Function Documentation

boundaryField() [1/2]

template<typename ValueType >

BoundaryFields< ValueType > & NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::boundaryField ( )

inline

Returns a reference to the boundary field.

Returns

The reference to the boundary field.

Definition at line 104 of file geometricField.hpp.

boundaryField() [2/2]

template<typename ValueType >

const BoundaryFields< ValueType > & NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::boundaryField ( ) const

inline

Returns a const reference to the boundary field.

Returns

The const reference to the boundary field.

Definition at line 97 of file geometricField.hpp.

exec()

template<typename ValueType >

const Executor & NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::exec ( ) const

inline

Returns a const reference to the executor object.

Returns

The const reference to the executor object.

Definition at line 111 of file geometricField.hpp.

internalField() [1/2]

template<typename ValueType >

Field< ValueType > & NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::internalField ( )

inline

Returns a reference to the internal field.

Returns

The reference to the internal field.

Definition at line 83 of file geometricField.hpp.

internalField() [2/2]

template<typename ValueType >

const Field< ValueType > & NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::internalField ( ) const

inline

Returns a const reference to the internal field.

Returns

The const reference to the internal field.

Definition at line 76 of file geometricField.hpp.

mesh()

template<typename ValueType >

const UnstructuredMesh & NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< 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 118 of file geometricField.hpp.

size()

template<typename ValueType >

size_t NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::size ( ) const

inline

Returns the size of the internal field.

Returns

The size of the internal field

Definition at line 90 of file geometricField.hpp.

Member Data Documentation

exec_

template<typename ValueType >

Executor NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::exec_

protected

Definition at line 124 of file geometricField.hpp.

field_

template<typename ValueType >

DomainField<ValueType> NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::field_

protected

Definition at line 126 of file geometricField.hpp.

mesh_

template<typename ValueType >

const UnstructuredMesh& NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::mesh_

protected

Definition at line 125 of file geometricField.hpp.

name

template<typename ValueType >

std::string NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >::name

Definition at line 120 of file geometricField.hpp.

---

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

• /home/runner/work/NeoFOAM/NeoFOAM/include/NeoFOAM/finiteVolume/cellCentred/fields/geometricField.hpp