A sampledSurface that calculates the PLIC interface in VoF simulations Only works in combination with isoAdvector and a reconstruction scheme. More...

Inheritance diagram for sampledInterface:

[legend]

Collaboration diagram for sampledInterface:

[legend]

Public Member Functions
	TypeName ("sampledInterface")
	Runtime type information. More...

	sampledInterface (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~sampledInterface ()=default
	Destructor. More...

const reconstructionSchemes::interface &	surface () const

virtual bool	needsUpdate () const
	Does the surface need an update? More...

virtual bool	expire ()
	Mark the surface as needing an update. More...

virtual bool	update ()
	Update the surface as required. More...

virtual const pointField &	points () const
	Points of surface. More...

virtual const faceList &	faces () const
	Faces of surface. More...

virtual const labelList &	zoneIds () const
	Const access to per-face zone/region information. More...

virtual const vectorField &	Sf () const
	Face area magnitudes. More...

virtual const scalarField &	magSf () const
	Face area magnitudes. More...

virtual const vectorField &	Cf () const
	Face centres. More...

virtual tmp< scalarField >	sample (const interpolation< scalar > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< vectorField >	sample (const interpolation< vector > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< sphericalTensorField >	sample (const interpolation< sphericalTensor > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< symmTensorField >	sample (const interpolation< symmTensor > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< tensorField >	sample (const interpolation< tensor > &sampler) const
	Sample volume field onto surface faces. More...

virtual tmp< scalarField >	interpolate (const interpolation< scalar > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual tmp< vectorField >	interpolate (const interpolation< vector > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual tmp< sphericalTensorField >	interpolate (const interpolation< sphericalTensor > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual tmp< symmTensorField >	interpolate (const interpolation< symmTensor > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual tmp< tensorField >	interpolate (const interpolation< tensor > &interpolator) const
	Interpolate volume field onto surface points. More...

virtual void	print (Ostream &os, int level=0) const
	Print information. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnPoints (const interpolation< Type > &interpolator) const

Public Member Functions inherited from sampledSurface
	TypeName ("sampledSurface")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))
	Declare run-time constructor selection table. More...

	sampledSurface (const word &name, const polyMesh &mesh, const bool interpolateToPoints=false)
	Construct from name, mesh. More...

	sampledSurface (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< sampledSurface >	clone () const
	Clone. More...

virtual	~sampledSurface ()
	Destructor - calls clearGeom() More...

const polyMesh &	mesh () const noexcept
	Access to the underlying mesh. More...

const word &	name () const noexcept
	Name of surface. More...

bool	enabled () const noexcept
	Surface is enabled. More...

bool	invariant () const noexcept
	Surface is invariant with geometry change (caution) More...

bool	isPointData () const noexcept
	Using interpolation to surface points. More...

virtual bool	isPointData (const bool on)
	Change point/cell representation, may trigger an expire(). More...

virtual bool	needsUpdate () const =0
	Does the surface need an update? More...

virtual bool	expire ()=0
	Mark the surface as needing an update. More...

virtual bool	update ()=0
	Update the surface as required. More...

virtual const pointField &	points () const =0
	Points of surface. More...

virtual const faceList &	faces () const =0
	Faces of surface. More...

virtual const vectorField &	Sf () const =0
	Face area vectors. More...

virtual const scalarField &	magSf () const =0
	Face area magnitudes. More...

virtual const vectorField &	Cf () const =0
	Face centres. More...

scalar	area () const
	The total surface area. More...

virtual bool	hasFaceIds () const
	If element ids/order of the original surface are available. More...

polySurface *	getRegistrySurface (const objectRegistry &obr, word lookupName="") const
	Get surface from registry if available. More...

polySurface *	storeRegistrySurface (objectRegistry &obr, word lookupName="") const
	Copy surface into registry. More...

bool	removeRegistrySurface (objectRegistry &obr, word lookupName="") const
	Remove surface from registry. More...

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const
	Copy/store sampled field onto registered surface (if it exists) More...

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const
	Move/store sampled field onto registered surface (if it exists) More...

virtual tmp< scalarField >	sample (const interpolation< scalar > &sampler) const =0
	Sample volume field onto surface faces. More...

virtual tmp< vectorField >	sample (const interpolation< vector > &sampler) const =0
	Sample volume field onto surface faces. More...

virtual tmp< sphericalTensorField >	sample (const interpolation< sphericalTensor > &sampler) const =0
	Sample volume field onto surface faces. More...

virtual tmp< symmTensorField >	sample (const interpolation< symmTensor > &sampler) const =0
	Sample volume field onto surface faces. More...

virtual tmp< tensorField >	sample (const interpolation< tensor > &sampler) const =0
	Sample volume field onto surface faces. More...

virtual bool	withSurfaceFields () const
	Can it sample surface-fields? More...

virtual tmp< scalarField >	sample (const surfaceScalarField &sField) const
	Sample surface field onto surface. More...

virtual tmp< vectorField >	sample (const surfaceVectorField &sField) const
	Sample surface field onto surface. More...

virtual tmp< sphericalTensorField >	sample (const surfaceSphericalTensorField &sField) const
	Sample surface field onto surface. More...

virtual tmp< symmTensorField >	sample (const surfaceSymmTensorField &sField) const
	Sample surface field onto surface. More...

virtual tmp< tensorField >	sample (const surfaceTensorField &sField) const
	Sample surface field onto surface. More...

virtual tmp< scalarField >	interpolate (const interpolation< scalar > &interpolator) const =0
	Interpolate volume field onto surface points. More...

virtual tmp< vectorField >	interpolate (const interpolation< vector > &interpolator) const =0
	Interpolate volume field onto surface points. More...

virtual tmp< sphericalTensorField >	interpolate (const interpolation< sphericalTensor > &interpolator) const =0
	Interpolate volume field onto surface points. More...

virtual tmp< symmTensorField >	interpolate (const interpolation< symmTensor > &interpolator) const =0
	Interpolate volume field onto surface points. More...

virtual tmp< tensorField >	interpolate (const interpolation< tensor > &interpolator) const =0
	Interpolate volume field onto surface points. More...

virtual void	rename (const word &newName)
	Rename. More...

virtual void	print (Ostream &os, int level=0) const
	Print information. More...

bool	interpolate () const noexcept
	Same as isPointData() More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts, const Type &defaultValue)

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts)

template<class Type >
Foam::tmp< Foam::VolumeField< Type > >	pointAverage (const PointField< Type > &pfld)

Public Member Functions inherited from meshedSurf
constexpr	meshedSurf () noexcept=default
	Default construct. More...

virtual	~meshedSurf ()=default
	Destructor. More...

virtual const pointField &	points () const =0
	The points used for the surface. More...

virtual const faceList &	faces () const =0
	The faces used for the surface. More...

virtual const labelList &	zoneIds () const
	Per-face zone/region information. More...

virtual const labelList &	faceIds () const
	Per-face identifier (eg, element Id) More...

Additional Inherited Members
Static Public Member Functions inherited from sampledSurface
static autoPtr< sampledSurface >	New (const word &name, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected surface. More...

Protected Member Functions inherited from sampledSurface
virtual void	clearGeom () const
	Additional cleanup when clearing the geometry. More...

	sampledSurface (const word &name, std::nullptr_t)
	Construct null. More...

Static Protected Member Functions inherited from sampledSurface
template<class Type >
static tmp< Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts, const Type &defaultValue=Type(Zero))
	Loop for sampling volume elements to faces. More...

template<class Type >
static tmp< Field< Type > >	sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts)
	Loop for interpolating volume elements to face points. More...

template<class Type >
static tmp< VolumeField< Type > >	pointAverage (const PointField< Type > &pfld)
	Create cell values by averaging the point values. More...

Detailed Description

A sampledSurface that calculates the PLIC interface in VoF simulations Only works in combination with isoAdvector and a reconstruction scheme.

This is often embedded as part of a sampled surfaces function object.

Usage

Example of function object partial specification:

surfaces
{
    freeSurf
    {
        type        interface;
        interpolate false;
    }
}

Where the sub-entries comprise:

Property	Description	Required	Default
`type`	interface	yes

Original code supplied by Henning Scheufler, DLR (2019)

Source files

Definition at line 88 of file sampledInterface.H.

Constructor & Destructor Documentation

◆ sampledInterface()

sampledInterface	(	const word &	name,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

Construct from dictionary.

Definition at line 113 of file sampledInterface.C.

References polyMesh::boundaryMesh(), polyMesh::cellZones(), DebugInfo, dict, Foam::endl(), ZoneMesh< ZoneType, MeshType >::findIndex(), polyBoundaryMesh::findPatchID(), UList< T >::first(), Foam::flatOutput(), dictionary::found(), sampledSurface::mesh(), dictionary::readEntry(), dictionary::readIfPresent(), and List< T >::resize().

Here is the call graph for this function:

◆ ~sampledInterface()

virtual ~sampledInterface ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "sampledInterface" )

Runtime type information.

◆ surface()

const reconstructionSchemes::interface & surface ( ) const

inline

Definition at line 156 of file sampledInterface.H.

Referenced by sampledInterface::Cf(), sampledInterface::faces(), sampledInterface::magSf(), sampledInterface::points(), sampledInterface::sampleOnFaces(), and sampledInterface::Sf().

Here is the caller graph for this function:

◆ needsUpdate()

bool needsUpdate ( ) const

virtual

Does the surface need an update?

Implements sampledSurface.

Definition at line 147 of file sampledInterface.C.

References mesh, fvMesh::time(), and TimeState::timeIndex().

Here is the call graph for this function:

◆ expire()

bool expire ( )

virtual

Mark the surface as needing an update.

May also free up unneeded data. Return false if surface was already marked as expired.

Implements sampledSurface.

Definition at line 155 of file sampledInterface.C.

◆ update()

bool update ( )

virtual

Update the surface as required.

Do nothing (and return false) if no update was needed

Implements sampledSurface.

Definition at line 175 of file sampledInterface.C.

◆ points()

virtual const pointField & points ( ) const

inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 175 of file sampledInterface.H.

References PrimitivePatch< FaceList, PointField >::points(), and sampledInterface::surface().

Referenced by sampledInterface::sampleOnFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faces()

virtual const faceList & faces ( ) const

inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 181 of file sampledInterface.H.

References sampledInterface::surface(), and MeshedSurface< Face >::surfFaces().

Here is the call graph for this function:

◆ zoneIds()

virtual const labelList & zoneIds ( ) const

inlinevirtual

Const access to per-face zone/region information.

Reimplemented from meshedSurf.

Definition at line 187 of file sampledInterface.H.

References List< label >::null().

Here is the call graph for this function:

◆ Sf()

virtual const vectorField & Sf ( ) const

inlinevirtual

Face area magnitudes.

Implements sampledSurface.

Definition at line 193 of file sampledInterface.H.

References MeshedSurface< Face >::Sf(), and sampledInterface::surface().

Here is the call graph for this function:

◆ magSf()

virtual const scalarField & magSf ( ) const

inlinevirtual

Face area magnitudes.

Implements sampledSurface.

Definition at line 199 of file sampledInterface.H.

References MeshedSurface< Face >::magSf(), and sampledInterface::surface().

Here is the call graph for this function:

◆ Cf()

virtual const vectorField & Cf ( ) const

inlinevirtual

Face centres.

Implements sampledSurface.

Definition at line 205 of file sampledInterface.H.

References MeshedSurface< Face >::Cf(), and sampledInterface::surface().

Here is the call graph for this function:

◆ sample() [1/5]

Foam::tmp< Foam::scalarField > sample ( const interpolation< scalar > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 181 of file sampledInterface.C.

◆ sample() [2/5]

Foam::tmp< Foam::vectorField > sample ( const interpolation< vector > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 190 of file sampledInterface.C.

◆ sample() [3/5]

Foam::tmp< Foam::sphericalTensorField > sample ( const interpolation< sphericalTensor > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 199 of file sampledInterface.C.

◆ sample() [4/5]

Foam::tmp< Foam::symmTensorField > sample ( const interpolation< symmTensor > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 208 of file sampledInterface.C.

◆ sample() [5/5]

Foam::tmp< Foam::tensorField > sample ( const interpolation< tensor > & sampler ) const

virtual

Sample volume field onto surface faces.

Implements sampledSurface.

Definition at line 217 of file sampledInterface.C.

◆ interpolate() [1/5]

Foam::tmp< Foam::scalarField > interpolate ( const interpolation< scalar > & interpolator ) const

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 226 of file sampledInterface.C.

◆ interpolate() [2/5]

Foam::tmp< Foam::vectorField > interpolate ( const interpolation< vector > & interpolator ) const

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 235 of file sampledInterface.C.

◆ interpolate() [3/5]

Foam::tmp< Foam::sphericalTensorField > interpolate ( const interpolation< sphericalTensor > & interpolator ) const

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 243 of file sampledInterface.C.

◆ interpolate() [4/5]

Foam::tmp< Foam::symmTensorField > interpolate ( const interpolation< symmTensor > & interpolator ) const

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 252 of file sampledInterface.C.

◆ interpolate() [5/5]

Foam::tmp< Foam::tensorField > interpolate ( const interpolation< tensor > & interpolator ) const

virtual

Interpolate volume field onto surface points.

Implements sampledSurface.

Definition at line 261 of file sampledInterface.C.

◆ print()

void print	(	Ostream &	os,
		int	level = `0`
	)		const

virtual

Print information.

Reimplemented from sampledSurface.

Definition at line 270 of file sampledInterface.C.

References Foam::name(), and os().

Here is the call graph for this function:

◆ sampleOnFaces()

Foam::tmp< Foam::Field< Type > > sampleOnFaces ( const interpolation< Type > & sampler ) const

Definition at line 38 of file sampledInterfaceTemplates.C.

References sampledInterface::points(), sampledSurface::sampleOnFaces(), and sampledInterface::surface().

Here is the call graph for this function:

◆ sampleOnPoints()

Foam::tmp< Foam::Field< Type > > sampleOnPoints ( const interpolation< Type > & interpolator ) const

Definition at line 57 of file sampledInterfaceTemplates.C.

References notImplemented.

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

src/transportModels/geometricVoF/sampledInterface/sampledInterface.H
src/transportModels/geometricVoF/sampledInterface/sampledInterface.C
src/transportModels/geometricVoF/sampledInterface/sampledInterfaceTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledInterface()

◆ ~sampledInterface()

Member Function Documentation

◆ TypeName()

◆ surface()

◆ needsUpdate()

◆ expire()

◆ update()

◆ points()

◆ faces()

◆ zoneIds()

◆ Sf()

◆ magSf()

◆ Cf()

◆ sample() [1/5]

◆ sample() [2/5]

◆ sample() [3/5]

◆ sample() [4/5]

◆ sample() [5/5]

◆ interpolate() [1/5]

◆ interpolate() [2/5]

◆ interpolate() [3/5]

◆ interpolate() [4/5]

◆ interpolate() [5/5]

◆ print()

◆ sampleOnFaces()

◆ sampleOnPoints()