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")

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

virtual	~sampledInterface ()=default

const reconstructionSchemes::interface &	surface () const

virtual bool	needsUpdate () const

virtual bool	expire ()

virtual bool	update ()

virtual const pointField &	points () const

virtual const faceList &	faces () const

virtual const labelList &	zoneIds () const

virtual const vectorField &	Sf () const

virtual const scalarField &	magSf () const

virtual const vectorField &	Cf () const

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

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

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

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

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

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

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

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

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

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

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

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")

	declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))

	sampledSurface (const word &name, const polyMesh &mesh, const bool interpolateToPoints=false)

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

autoPtr< sampledSurface >	clone () const

virtual	~sampledSurface ()

const polyMesh &	mesh () const noexcept

const word &	name () const noexcept

bool	enabled () const noexcept

bool	invariant () const noexcept

bool	isPointData () const noexcept

virtual bool	isPointData (const bool on)

scalar	area () const

virtual bool	hasFaceIds () const

polySurface *	getRegistrySurface (const objectRegistry &obr, word lookupName="") const

polySurface *	storeRegistrySurface (objectRegistry &obr, word lookupName="") const

bool	removeRegistrySurface (objectRegistry &obr, word lookupName="") const

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const

surfMesh *	getSurfMesh (word lookupName="") const

surfMesh *	storeSurfMesh (word lookupName="") const

bool	removeSurfMesh (word lookupName="") const

template<class Type , class GeoMeshType >
bool	storeSurfMeshField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const

template<class Type , class GeoMeshType >
bool	storeSurfMeshField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const

virtual bool	withSurfaceFields () const

virtual tmp< scalarField >	sample (const surfaceScalarField &sField) const

virtual tmp< vectorField >	sample (const surfaceVectorField &sField) const

virtual tmp< sphericalTensorField >	sample (const surfaceSphericalTensorField &sField) const

virtual tmp< symmTensorField >	sample (const surfaceSymmTensorField &sField) const

virtual tmp< tensorField >	sample (const surfaceTensorField &sField) const

virtual void	rename (const word &newName)

bool	interpolate () const noexcept

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::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > >	pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld)

Public Member Functions inherited from meshedSurf
constexpr	meshedSurf () noexcept=default

virtual	~meshedSurf ()=default

virtual const labelList &	faceIds () const

Additional Inherited Members
Static Public Member Functions inherited from sampledSurface
static autoPtr< sampledSurface >	New (const word &name, const polyMesh &mesh, const dictionary &dict)

Static Public Attributes inherited from sampledSurface
static const wordList	surfaceFieldTypes

Protected Member Functions inherited from sampledSurface
virtual void	clearGeom () const

	sampledSurface (const word &name, std::nullptr_t)

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))

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

template<class Type >
static tmp< GeometricField< Type, fvPatchField, volMesh > >	pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld)

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 84 of file sampledInterface.H.

Constructor & Destructor Documentation

◆ sampledInterface()

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

Definition at line 107 of file sampledInterface.C.

References polyMesh::boundaryMesh(), polyMesh::cellZones(), DebugInfo, dict, Foam::endl(), ZoneMesh::findIndex(), polyBoundaryMesh::findPatchID(), Foam::flatOutput(), dictionary::found(), mesh, dictionary::readEntry(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ ~sampledInterface()

virtual ~sampledInterface ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "sampledInterface" )

◆ surface()

const reconstructionSchemes::interface& surface ( ) const

inline

Definition at line 152 of file sampledInterface.H.

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

Here is the caller graph for this function:

◆ needsUpdate()

bool needsUpdate ( ) const

virtual

Implements sampledSurface.

Definition at line 140 of file sampledInterface.C.

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

Here is the call graph for this function:

◆ expire()

bool expire ( )

virtual

Implements sampledSurface.

Definition at line 148 of file sampledInterface.C.

◆ update()

bool update ( )

virtual

Implements sampledSurface.

Definition at line 168 of file sampledInterface.C.

◆ points()

virtual const pointField& points ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 171 of file sampledInterface.H.

References sampledInterface::surface().

Here is the call graph for this function:

◆ faces()

virtual const faceList& faces ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 177 of file sampledInterface.H.

References sampledInterface::surface(), and MeshedSurface::surfFaces().

Here is the call graph for this function:

◆ zoneIds()

virtual const labelList& zoneIds ( ) const

inlinevirtual

Reimplemented from meshedSurf.

Definition at line 183 of file sampledInterface.H.

References List::null().

Here is the call graph for this function:

◆ Sf()

virtual const vectorField& Sf ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 189 of file sampledInterface.H.

References MeshedSurface::Sf(), and sampledInterface::surface().

Here is the call graph for this function:

◆ magSf()

virtual const scalarField& magSf ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 195 of file sampledInterface.H.

References MeshedSurface::magSf(), and sampledInterface::surface().

Here is the call graph for this function:

◆ Cf()

virtual const vectorField& Cf ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 201 of file sampledInterface.H.

References MeshedSurface::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

Implements sampledSurface.

Definition at line 175 of file sampledInterface.C.

◆ sample() [2/5]

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

virtual

Implements sampledSurface.

Definition at line 184 of file sampledInterface.C.

◆ sample() [3/5]

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

virtual

Implements sampledSurface.

Definition at line 193 of file sampledInterface.C.

◆ sample() [4/5]

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

virtual

Implements sampledSurface.

Definition at line 202 of file sampledInterface.C.

◆ sample() [5/5]

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

virtual

Implements sampledSurface.

Definition at line 211 of file sampledInterface.C.

◆ interpolate() [1/5]

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

virtual

Implements sampledSurface.

Definition at line 220 of file sampledInterface.C.

◆ interpolate() [2/5]

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

virtual

Implements sampledSurface.

Definition at line 229 of file sampledInterface.C.

◆ interpolate() [3/5]

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

virtual

Implements sampledSurface.

Definition at line 237 of file sampledInterface.C.

◆ interpolate() [4/5]

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

virtual

Implements sampledSurface.

Definition at line 246 of file sampledInterface.C.

◆ interpolate() [5/5]

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

virtual

Implements sampledSurface.

Definition at line 255 of file sampledInterface.C.

◆ print()

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

virtual

Reimplemented from sampledSurface.

Definition at line 263 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 32 of file sampledInterfaceTemplates.C.

References points.

◆ sampleOnPoints()

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

Definition at line 51 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()