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

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

#include <surfaceField.hpp>

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

Public Member Functions
	SurfaceField (const Executor &exec, std::string fieldName, const UnstructuredMesh &mesh, const std::vector< SurfaceBoundary< ValueType > > &boundaryConditions)
	Constructor for a surfaceVector with a given name and mesh.
	SurfaceField (const Executor &exec, const UnstructuredMesh &mesh, const Field< ValueType > &domainVector, const std::vector< SurfaceBoundary< ValueType > > &boundaryConditions)
	SurfaceField (const Executor &exec, const UnstructuredMesh &mesh, const Vector< ValueType > &internalVector, const BoundaryData< ValueType > &boundaryVectors, 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 NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >
	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.

Additional Inherited Members
Public Types inherited from NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >
typedef ValueType	ElementType
Public Attributes inherited from NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >
std::string	name
Protected Attributes inherited from NeoN::finiteVolume::cellCentred::DomainMixin< ValueType >
Executor	exec_
const UnstructuredMesh &	mesh_
Field< ValueType >	field_

Detailed Description

template<typename ValueType>
class NeoN::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 DomainMixin class and provides methods for correcting boundary conditions.

Template Parameters

ValueType

The value type of the field.

Definition at line 25 of file surfaceField.hpp.

Constructor & Destructor Documentation

SurfaceField() [1/4]

template<typename ValueType >

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

inline

Constructor for a surfaceVector with a given name and mesh.

Parameters

exec	The executor
fieldName	The name of the field
mesh	The underlying mesh
boundaryConditions	a vector of boundary conditions

Definition at line 38 of file surfaceField.hpp.

SurfaceField() [2/4]

template<typename ValueType >

NeoN::finiteVolume::cellCentred::SurfaceField< ValueType >::SurfaceField ( const Executor &  exec, const UnstructuredMesh &  mesh, const Field< ValueType > &  domainVector, const std::vector< SurfaceBoundary< ValueType > > &  boundaryConditions  )

inline

Definition at line 62 of file surfaceField.hpp.

SurfaceField() [3/4]

template<typename ValueType >

NeoN::finiteVolume::cellCentred::SurfaceField< ValueType >::SurfaceField ( const Executor &  exec, const UnstructuredMesh &  mesh, const Vector< ValueType > &  internalVector, const BoundaryData< ValueType > &  boundaryVectors, const std::vector< SurfaceBoundary< ValueType > > &  boundaryConditions  )

inline

Definition at line 78 of file surfaceField.hpp.

SurfaceField() [4/4]

template<typename ValueType >

NeoN::finiteVolume::cellCentred::SurfaceField< ValueType >::SurfaceField ( const SurfaceField< ValueType > &  other )

inline

Copy constructor for a surface field.

Parameters

other

The surface field to copy.

Definition at line 94 of file surfaceField.hpp.

Member Function Documentation

correctBoundaryConditions()

template<typename ValueType >

void NeoN::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 104 of file surfaceField.hpp.

---

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

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