NeoFOAM
WIP Prototype of a modern OpenFOAM core
Loading...
Searching...
No Matches
Public Member Functions | List of all members
NeoFOAM::DomainField< ValueType > Class Template Reference

Represents the domain fields for a computational domain. More...

#include <domainField.hpp>

Public Member Functions

 DomainField (const Executor &exec)
 
 DomainField (const Executor &exec, size_t nCells, size_t nBoundaryFaces, size_t nBoundaries)
 
 DomainField (const Executor &exec, const Field< ValueType > &internalField, const BoundaryFields< ValueType > &boundaryFields)
 
 DomainField (const Executor &exec, const Field< ValueType > &internalField, size_t nBoundaryFaces, size_t nBoundaries)
 
 DomainField (const Executor &exec, const UnstructuredMesh &mesh)
 
 DomainField (const DomainField< ValueType > &rhs)
 
 DomainField (DomainField< ValueType > &&rhs)
 
DomainField< ValueType > & operator= (const DomainField< ValueType > &rhs)
 
DomainField< ValueType > & operator= (DomainField< ValueType > &&rhs)
 
const Field< ValueType > & internalField () const
 
Field< ValueType > & internalField ()
 
const BoundaryFields< ValueType > & boundaryField () const
 
BoundaryFields< ValueType > & boundaryField ()
 
const Executorexec () const
 

Detailed Description

template<typename ValueType>
class NeoFOAM::DomainField< ValueType >

Represents the domain fields for a computational domain.

The DomainField class stores the internal fields and boundary information for a computational domain. It provides access to the computed values, reference values, value fractions, reference gradients, boundary types, offsets, and the number of boundaries and boundary faces.

Template Parameters
ValueTypeThe type of the underlying field values

Definition at line 31 of file domainField.hpp.

Constructor & Destructor Documentation

◆ DomainField() [1/7]

template<typename ValueType >
NeoFOAM::DomainField< ValueType >::DomainField ( const Executor exec)
inline

Definition at line 35 of file domainField.hpp.

◆ DomainField() [2/7]

template<typename ValueType >
NeoFOAM::DomainField< ValueType >::DomainField ( const Executor exec,
size_t  nCells,
size_t  nBoundaryFaces,
size_t  nBoundaries 
)
inline

Definition at line 39 of file domainField.hpp.

◆ DomainField() [3/7]

template<typename ValueType >
NeoFOAM::DomainField< ValueType >::DomainField ( const Executor exec,
const Field< ValueType > &  internalField,
const BoundaryFields< ValueType > &  boundaryFields 
)
inline

Definition at line 44 of file domainField.hpp.

◆ DomainField() [4/7]

template<typename ValueType >
NeoFOAM::DomainField< ValueType >::DomainField ( const Executor exec,
const Field< ValueType > &  internalField,
size_t  nBoundaryFaces,
size_t  nBoundaries 
)
inline

Definition at line 52 of file domainField.hpp.

◆ DomainField() [5/7]

template<typename ValueType >
NeoFOAM::DomainField< ValueType >::DomainField ( const Executor exec,
const UnstructuredMesh mesh 
)
inline

Definition at line 62 of file domainField.hpp.

◆ DomainField() [6/7]

template<typename ValueType >
NeoFOAM::DomainField< ValueType >::DomainField ( const DomainField< ValueType > &  rhs)
inline

Definition at line 68 of file domainField.hpp.

◆ DomainField() [7/7]

template<typename ValueType >
NeoFOAM::DomainField< ValueType >::DomainField ( DomainField< ValueType > &&  rhs)
inline

Definition at line 73 of file domainField.hpp.

Member Function Documentation

◆ boundaryField() [1/2]

template<typename ValueType >
BoundaryFields< ValueType > & NeoFOAM::DomainField< ValueType >::boundaryField ( )
inline

Definition at line 104 of file domainField.hpp.

◆ boundaryField() [2/2]

template<typename ValueType >
const BoundaryFields< ValueType > & NeoFOAM::DomainField< ValueType >::boundaryField ( ) const
inline

Definition at line 101 of file domainField.hpp.

◆ exec()

template<typename ValueType >
const Executor & NeoFOAM::DomainField< ValueType >::exec ( ) const
inline

Definition at line 106 of file domainField.hpp.

◆ internalField() [1/2]

template<typename ValueType >
Field< ValueType > & NeoFOAM::DomainField< ValueType >::internalField ( )
inline

Definition at line 98 of file domainField.hpp.

◆ internalField() [2/2]

template<typename ValueType >
const Field< ValueType > & NeoFOAM::DomainField< ValueType >::internalField ( ) const
inline

Definition at line 95 of file domainField.hpp.

◆ operator=() [1/2]

template<typename ValueType >
DomainField< ValueType > & NeoFOAM::DomainField< ValueType >::operator= ( const DomainField< ValueType > &  rhs)
inline

Definition at line 79 of file domainField.hpp.

◆ operator=() [2/2]

template<typename ValueType >
DomainField< ValueType > & NeoFOAM::DomainField< ValueType >::operator= ( DomainField< ValueType > &&  rhs)
inline

Definition at line 87 of file domainField.hpp.


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