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

#include <surfaceBoundaryFactory.hpp>

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

Public Member Functions
	SurfaceBoundaryFactory (const UnstructuredMesh &mesh, const Dictionary &, localIdx patchID)
virtual void	correctBoundaryCondition (Field< ValueType > &field)=0
virtual void	set (Field< ValueType > &domainVector)
	One-time patch initialisation, applied once per field before the first update().
virtual void	update (Field< ValueType > &domainVector)
	Per-iteration boundary update, applied on every correctBoundaryConditions() call.
virtual std::unique_ptr< SurfaceBoundaryFactory >	clone () const =0
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

Static Public Member Functions
static std::string	name ()

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::SurfaceBoundaryFactory< ValueType >

Definition at line 18 of file surfaceBoundaryFactory.hpp.

Constructor & Destructor Documentation

SurfaceBoundaryFactory()

template<typename ValueType >

NeoN::finiteVolume::cellCentred::SurfaceBoundaryFactory< ValueType >::SurfaceBoundaryFactory ( const UnstructuredMesh &  mesh, const Dictionary &  , localIdx  patchID  )

inline

Definition at line 28 of file surfaceBoundaryFactory.hpp.

Member Function Documentation

clone()

template<typename ValueType >

virtual std::unique_ptr< SurfaceBoundaryFactory > NeoN::finiteVolume::cellCentred::SurfaceBoundaryFactory< ValueType >::clone ( ) const

pure virtual

correctBoundaryCondition()

template<typename ValueType >

virtual void NeoN::finiteVolume::cellCentred::SurfaceBoundaryFactory< ValueType >::correctBoundaryCondition ( Field< ValueType > &  field )

pure virtual

name()

template<typename ValueType >

static std::string NeoN::finiteVolume::cellCentred::SurfaceBoundaryFactory< ValueType >::name ( )

inlinestatic

Definition at line 26 of file surfaceBoundaryFactory.hpp.

set()

template<typename ValueType >

virtual void NeoN::finiteVolume::cellCentred::SurfaceBoundaryFactory< ValueType >::set ( Field< ValueType > &  domainVector )

inlinevirtual

One-time patch initialisation, applied once per field before the first update().

For patch data fixed for the lifetime of the field (e.g. constant mixed-BC coefficients). Default: no-op.

Definition at line 41 of file surfaceBoundaryFactory.hpp.

update()

template<typename ValueType >

virtual void NeoN::finiteVolume::cellCentred::SurfaceBoundaryFactory< ValueType >::update ( Field< ValueType > &  domainVector )

inlinevirtual

Per-iteration boundary update, applied on every correctBoundaryConditions() call.

Default forwards to correctBoundaryCondition() so non-split BCs are unchanged.

Definition at line 48 of file surfaceBoundaryFactory.hpp.

---

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

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