A sampledSurface defined by a surface of iso value. It only recalculates the iso-surface if time changes. To be used in sampleSurfaces / functionObjects. More...

Inheritance diagram for sampledIsoSurface:

[legend]

Collaboration diagram for sampledIsoSurface:

[legend]

Public Member Functions
	TypeName ("sampledIsoSurface")

	sampledIsoSurface (const isoSurfaceParams &params, const word &name, const polyMesh &mesh, const dictionary &dict)

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

virtual	~sampledIsoSurface ()

virtual bool	needsUpdate () const

virtual bool	expire ()

virtual bool	update ()

const meshedSurface &	surface () const

const labelList &	meshCells () const

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

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnIsoSurfacePoints (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

Protected Member Functions
bool	hasIsoSurface () const

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

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

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

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 defined by a surface of iso value. It only recalculates the iso-surface if time changes. To be used in sampleSurfaces / functionObjects.

Usage

Example of function object partial specification:

surfaces
{
    surface1
    {
        type     isoSurface;
        isoField T;
        isoValue 373;
        isoMethod topo;
    }
}

Where the sub-entries comprise:

Property	Description	Required	Default
`type`	isoSurface	yes
`isoField`	field name for obtaining iso-surface	yes
`isoValue`	value of iso-surface	yes
`isoValues`	values for iso-surfaces	yes
`isoMethod`	Iso-algorithm (cell/topo/point)	no	topo
`average`	cell values from averaged point values	no	false
`bounds`	limit with bounding box	no
`zone`	limit to cell zone (name or regex)	no
`zones`	limit to cell zones (names, regexs)	no
`simpleSubMesh`	Simple sub-meshing in algorithm itself	no	false
`exposedPatchName`	name for zone subset	optional
`regularise`	point snapping (bool or enum)	no	true
`triangulate`	triangulate faces (if regularise)	no	false
`mergeTol`	tolerance for merging points	no	1e-6

Some options are limited to particular algorithms.

triangulate is topo-only
simpleSubMesh and multiple isoValues are not available for point.

Note: For the isoMethod point should use a "cellPoint" sampleScheme since the triangles generated with this algorithm span across cells.

Source files

Definition at line 169 of file sampledIsoSurface.H.

Constructor & Destructor Documentation

◆ sampledIsoSurface() [1/2]

sampledIsoSurface	(	const isoSurfaceParams &	params,
		const word &	name,
		const polyMesh &	mesh,
		const dictionary &	dict
	)

Definition at line 576 of file sampledIsoSurface.C.

References isoSurfaceParams::ALGO_DEFAULT, isoSurfaceParams::ALGO_POINT, isoSurfaceParams::ALGO_TOPO, isoSurfaceParams::algorithm(), polyMesh::boundaryMesh(), polyMesh::cellZones(), DebugInfo, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, ZoneMesh::findIndex(), polyBoundaryMesh::findPatchID(), Foam::flatOutput(), dictionary::found(), Foam::inplaceUniqueSort(), IOWarningInFunction, mesh, Foam::nl, isoSurfaceParams::NONE, dictionary::readEntry(), and dictionary::readIfPresent().

Here is the call graph for this function:

◆ sampledIsoSurface() [2/2]

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

Definition at line 697 of file sampledIsoSurface.C.

◆ ~sampledIsoSurface()

~sampledIsoSurface ( )

virtual

Definition at line 709 of file sampledIsoSurface.C.

Member Function Documentation

◆ hasIsoSurface()

bool hasIsoSurface ( ) const

inlineprotected

Definition at line 283 of file sampledIsoSurface.H.

References bool.

◆ TypeName()

TypeName ( "sampledIsoSurface" )

◆ needsUpdate()

bool needsUpdate ( ) const

virtual

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledIsoSurface() [1/2]

◆ sampledIsoSurface() [2/2]

◆ ~sampledIsoSurface()

Member Function Documentation

◆ hasIsoSurface()

◆ TypeName()

◆ needsUpdate()

◆ expire()

◆ update()

◆ surface()

◆ meshCells()

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

◆ sampleOnIsoSurfacePoints()