NeoN::finiteVolume::cellCentred::BoundaryPatchMixin Class Reference

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

#include <boundaryPatchMixin.hpp>

Inheritance diagram for NeoN::finiteVolume::cellCentred::BoundaryPatchMixin:

Public Member Functions
	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

Protected Attributes
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

A base class for implementing derived boundary conditions.

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

Template Parameters

ValueType

The 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 22 of file boundaryPatchMixin.hpp.

Constructor & Destructor Documentation

BoundaryPatchMixin() [1/3]

NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::BoundaryPatchMixin ( )

inline

Definition at line 27 of file boundaryPatchMixin.hpp.

~BoundaryPatchMixin()

virtual NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::~BoundaryPatchMixin ( )

virtualdefault

BoundaryPatchMixin() [2/3]

NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::BoundaryPatchMixin ( const UnstructuredMesh &  mesh, localIdx  patchID  )

inline

Definition at line 31 of file boundaryPatchMixin.hpp.

BoundaryPatchMixin() [3/3]

NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::BoundaryPatchMixin ( localIdx  start, localIdx  end, localIdx  patchID  )

inline

Definition at line 36 of file boundaryPatchMixin.hpp.

Member Function Documentation

patchEnd()

localIdx NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::patchEnd ( ) const

inline

Definition at line 42 of file boundaryPatchMixin.hpp.

patchID()

localIdx NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::patchID ( ) const

inline

Definition at line 46 of file boundaryPatchMixin.hpp.

patchSize()

localIdx NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::patchSize ( ) const

inline

Definition at line 44 of file boundaryPatchMixin.hpp.

patchStart()

localIdx NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::patchStart ( ) const

inline

Definition at line 40 of file boundaryPatchMixin.hpp.

range()

std::pair< localIdx, localIdx > NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::range ( ) const

inline

Definition at line 48 of file boundaryPatchMixin.hpp.

Member Data Documentation

end_

localIdx NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::end_

protected

The end index of the patch in the boundaryVector.

Definition at line 54 of file boundaryPatchMixin.hpp.

patchID_

localIdx NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::patchID_

protected

The id of this patch.

Definition at line 52 of file boundaryPatchMixin.hpp.

start_

localIdx NeoN::finiteVolume::cellCentred::BoundaryPatchMixin::start_

protected

The start index of the patch in the boundaryVector.

Definition at line 53 of file boundaryPatchMixin.hpp.

---

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

• /home/runner/work/NeoN/NeoN/include/NeoN/finiteVolume/cellCentred/boundary/boundaryPatchMixin.hpp