NeoFOAM
WIP Prototype of a modern OpenFOAM core
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin Class Reference

A base class for implementing derived boundary conditions. More...

#include <boundaryPatchMixin.hpp>

Inheritance diagram for NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin:
NeoFOAM::finiteVolume::cellCentred::SurfaceBoundary< ValueType > NeoFOAM::finiteVolume::cellCentred::SurfaceBoundaryFactory< ValueType > NeoFOAM::finiteVolume::cellCentred::VolumeBoundary< ValueType > NeoFOAM::finiteVolume::cellCentred::VolumeBoundaryFactory< ValueType >

Public Member Functions

 BoundaryPatchMixin ()
 
virtual ~BoundaryPatchMixin ()=default
 
 BoundaryPatchMixin (const UnstructuredMesh &mesh, size_t patchID)
 
 BoundaryPatchMixin (label start, label end, size_t patchID)
 
label patchStart () const
 
label patchEnd () const
 
size_t patchSize () const
 
size_t patchID () const
 
std::pair< size_t, size_trange ()
 

Protected Attributes

size_t patchID_
 The id of this patch.
 
label start_
 The start index of the patch in the boundaryField.
 
label end_
 The end index of the patch in the boundaryField.
 

Detailed Description

A base class for implementing derived boundary conditions.

This class holds the information where a given boundary starts and ends in the consecutive boundaryFields class

Template Parameters
ValueTypeThe data type of the field.
Note
the class template parameters is currently needed since the correctBoundaryConditions functions which takes templated arguments is virtual.

Definition at line 25 of file boundaryPatchMixin.hpp.

Constructor & Destructor Documentation

◆ BoundaryPatchMixin() [1/3]

NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::BoundaryPatchMixin ( )
inline

Definition at line 30 of file boundaryPatchMixin.hpp.

◆ ~BoundaryPatchMixin()

virtual NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::~BoundaryPatchMixin ( )
virtualdefault

◆ BoundaryPatchMixin() [2/3]

NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::BoundaryPatchMixin ( const UnstructuredMesh mesh,
size_t  patchID 
)
inline

Definition at line 34 of file boundaryPatchMixin.hpp.

◆ BoundaryPatchMixin() [3/3]

NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::BoundaryPatchMixin ( label  start,
label  end,
size_t  patchID 
)
inline

Definition at line 39 of file boundaryPatchMixin.hpp.

Member Function Documentation

◆ patchEnd()

label NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::patchEnd ( ) const
inline

Definition at line 45 of file boundaryPatchMixin.hpp.

◆ patchID()

size_t NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::patchID ( ) const
inline

Definition at line 49 of file boundaryPatchMixin.hpp.

◆ patchSize()

size_t NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::patchSize ( ) const
inline

Definition at line 47 of file boundaryPatchMixin.hpp.

◆ patchStart()

label NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::patchStart ( ) const
inline

Definition at line 43 of file boundaryPatchMixin.hpp.

◆ range()

std::pair< size_t, size_t > NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::range ( )
inline

Definition at line 51 of file boundaryPatchMixin.hpp.

Member Data Documentation

◆ end_

label NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::end_
protected

The end index of the patch in the boundaryField.

Definition at line 57 of file boundaryPatchMixin.hpp.

◆ patchID_

size_t NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::patchID_
protected

The id of this patch.

Definition at line 55 of file boundaryPatchMixin.hpp.

◆ start_

label NeoFOAM::finiteVolume::cellCentred::BoundaryPatchMixin::start_
protected

The start index of the patch in the boundaryField.

Definition at line 56 of file boundaryPatchMixin.hpp.


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