NeoN
A framework for CFD software
Loading...
Searching...
No Matches
NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType > Class Template Reference

Represents a volume boundary field for a cell-centered finite volume method. More...

#include <volumeBoundaryFactory.hpp>

Inheritance diagram for NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >:
NeoN::finiteVolume::cellCentred::BoundaryPatchMixin

Public Member Functions

 VolumeBoundary (const UnstructuredMesh &mesh, const Dictionary &dict, localIdx patchID)
 VolumeBoundary (const VolumeBoundary &other)
virtual void correctBoundaryCondition (Field< ValueType > &domainVector)
virtual void correctBoundaryCondition (Field< ValueType > &domainVector, const BoundaryContext &ctx)
virtual void set (Field< ValueType > &domainVector)
virtual void update (Field< ValueType > &domainVector)
const BoundaryAttributes attributes () const
const std::string name () const
Public Member Functions inherited from NeoN::finiteVolume::cellCentred::BoundaryPatchMixin
 BoundaryPatchMixin ()
virtual ~BoundaryPatchMixin ()=default
 BoundaryPatchMixin (const UnstructuredMesh &mesh, localIdx patchID)
 BoundaryPatchMixin (localIdx start, localIdx end, localIdx patchID)
localIdx patchStart () const
localIdx patchEnd () const
localIdx patchSize () const
localIdx patchID () const
std::pair< localIdx, localIdx > range () const

Additional Inherited Members

Protected Attributes inherited from NeoN::finiteVolume::cellCentred::BoundaryPatchMixin
localIdx patchID_
 The id of this patch.
localIdx start_
 The start index of the patch in the boundaryVector.
localIdx end_
 The end index of the patch in the boundaryVector.

Detailed Description

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

Represents a volume boundary field for a cell-centered finite volume method.

Template Parameters
ValueTypeThe data type of the field.

Definition at line 102 of file volumeBoundaryFactory.hpp.

Constructor & Destructor Documentation

◆ VolumeBoundary() [1/2]

template<typename ValueType>
NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >::VolumeBoundary ( const UnstructuredMesh & mesh,
const Dictionary & dict,
localIdx patchID )
inline

Definition at line 106 of file volumeBoundaryFactory.hpp.

◆ VolumeBoundary() [2/2]

template<typename ValueType>
NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >::VolumeBoundary ( const VolumeBoundary< ValueType > & other)
inline

Definition at line 117 of file volumeBoundaryFactory.hpp.

Member Function Documentation

◆ attributes()

template<typename ValueType>
const BoundaryAttributes NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >::attributes ( ) const
inline

Definition at line 143 of file volumeBoundaryFactory.hpp.

◆ correctBoundaryCondition() [1/2]

template<typename ValueType>
virtual void NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >::correctBoundaryCondition ( Field< ValueType > & domainVector)
inlinevirtual

Definition at line 122 of file volumeBoundaryFactory.hpp.

◆ correctBoundaryCondition() [2/2]

template<typename ValueType>
virtual void NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >::correctBoundaryCondition ( Field< ValueType > & domainVector,
const BoundaryContext & ctx )
inlinevirtual

Definition at line 128 of file volumeBoundaryFactory.hpp.

◆ name()

template<typename ValueType>
const std::string NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >::name ( ) const
inline

Definition at line 148 of file volumeBoundaryFactory.hpp.

◆ set()

template<typename ValueType>
virtual void NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >::set ( Field< ValueType > & domainVector)
inlinevirtual

Definition at line 133 of file volumeBoundaryFactory.hpp.

◆ update()

template<typename ValueType>
virtual void NeoN::finiteVolume::cellCentred::VolumeBoundary< ValueType >::update ( Field< ValueType > & domainVector)
inlinevirtual

Definition at line 138 of file volumeBoundaryFactory.hpp.


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