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

Represents a surface field in a finite volume method. More...

#include <surfaceField.hpp>

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

Public Member Functions

 SurfaceField (const Executor &exec, std::string fieldName, const UnstructuredMesh &mesh, const std::vector< SurfaceBoundary< ValueType > > &boundaryConditions)
 Constructor for a surfaceField with a given name and mesh.
 
 SurfaceField (const Executor &exec, const UnstructuredMesh &mesh, const DomainField< ValueType > &domainField, const std::vector< SurfaceBoundary< ValueType > > &boundaryConditions)
 
 SurfaceField (const Executor &exec, const UnstructuredMesh &mesh, const Field< ValueType > &internalField, const BoundaryFields< ValueType > &boundaryFields, const std::vector< SurfaceBoundary< ValueType > > &boundaryConditions)
 
 SurfaceField (const SurfaceField &other)
 Copy constructor for a surface field.
 
void correctBoundaryConditions ()
 Corrects the boundary conditions of the surface field.
 
- Public Member Functions inherited from NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >
 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 Executorexec () const
 Returns a const reference to the executor object.
 
const UnstructuredMeshmesh () const
 Returns a const reference to the unstructured mesh object.
 

Additional Inherited Members

- Public Attributes inherited from NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >
std::string name
 
- Protected Attributes inherited from NeoFOAM::finiteVolume::cellCentred::GeometricFieldMixin< ValueType >
Executor exec_
 
const UnstructuredMeshmesh_
 
DomainField< ValueType > field_
 

Detailed Description

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

Represents a surface field in a finite volume method.

The SurfaceField class is a template class that represents a face-centered field in a finite volume method. It inherits from the GeometricFieldMixin class and provides methods for correcting boundary conditions.

Template Parameters
ValueTypeThe value type of the field.

Definition at line 25 of file surfaceField.hpp.

Constructor & Destructor Documentation

◆ SurfaceField() [1/4]

template<typename ValueType >
NeoFOAM::finiteVolume::cellCentred::SurfaceField< ValueType >::SurfaceField ( const Executor exec,
std::string  fieldName,
const UnstructuredMesh mesh,
const std::vector< SurfaceBoundary< ValueType > > &  boundaryConditions 
)
inline

Constructor for a surfaceField with a given name and mesh.

Parameters
execThe executor
fieldNameThe name of the field
meshThe underlying mesh
boundaryConditionsa vector of boundary conditions

Definition at line 38 of file surfaceField.hpp.

◆ SurfaceField() [2/4]

template<typename ValueType >
NeoFOAM::finiteVolume::cellCentred::SurfaceField< ValueType >::SurfaceField ( const Executor exec,
const UnstructuredMesh mesh,
const DomainField< ValueType > &  domainField,
const std::vector< SurfaceBoundary< ValueType > > &  boundaryConditions 
)
inline

Definition at line 65 of file surfaceField.hpp.

◆ SurfaceField() [3/4]

template<typename ValueType >
NeoFOAM::finiteVolume::cellCentred::SurfaceField< ValueType >::SurfaceField ( const Executor exec,
const UnstructuredMesh mesh,
const Field< ValueType > &  internalField,
const BoundaryFields< ValueType > &  boundaryFields,
const std::vector< SurfaceBoundary< ValueType > > &  boundaryConditions 
)
inline

Definition at line 82 of file surfaceField.hpp.

◆ SurfaceField() [4/4]

template<typename ValueType >
NeoFOAM::finiteVolume::cellCentred::SurfaceField< ValueType >::SurfaceField ( const SurfaceField< ValueType > &  other)
inline

Copy constructor for a surface field.

Parameters
otherThe surface field to copy.

Definition at line 98 of file surfaceField.hpp.

Member Function Documentation

◆ correctBoundaryConditions()

template<typename ValueType >
void NeoFOAM::finiteVolume::cellCentred::SurfaceField< ValueType >::correctBoundaryConditions ( )
inline

Corrects the boundary conditions of the surface field.

This function applies the correctBoundaryConditions() method to each boundary condition in the field.

Definition at line 108 of file surfaceField.hpp.


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