A sampledSurface defined by a surface of iso value. Always triangulated. To be used in sampleSurfaces / functionObjects. Recalculates iso surface only if time changes. More...

Inheritance diagram for sampledIsoSurface:

[legend]

Collaboration diagram for sampledIsoSurface:

[legend]

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

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

virtual	~sampledIsoSurface ()
	Destructor. More...

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

const isoSurface &	surface () const

void	getIsoField ()
	Lookup or read isoField. Sets volFieldPtr_ and pointFieldPtr_. More...

virtual tmp< scalarField >	sample (const volScalarField &) const
	Sample field on surface. More...

virtual tmp< vectorField >	sample (const volVectorField &) const
	Sample field on surface. More...

virtual tmp< sphericalTensorField >	sample (const volSphericalTensorField &) const
	Sample field on surface. More...

virtual tmp< symmTensorField >	sample (const volSymmTensorField &) const
	Sample field on surface. More...

virtual tmp< tensorField >	sample (const volTensorField &) const
	Sample field on surface. More...

virtual tmp< scalarField >	interpolate (const interpolation< scalar > &) const
	Interpolate field on surface. More...

virtual tmp< vectorField >	interpolate (const interpolation< vector > &) const
	Interpolate field on surface. More...

virtual tmp< sphericalTensorField >	interpolate (const interpolation< sphericalTensor > &) const
	Interpolate field on surface. More...

virtual tmp< symmTensorField >	interpolate (const interpolation< symmTensor > &) const
	Interpolate field on surface. More...

virtual tmp< tensorField >	interpolate (const interpolation< tensor > &) const
	Interpolate field on surface. More...

virtual void	print (Ostream &) const
	Write. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleField (const GeometricField< Type, fvPatchField, volMesh > &vField) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolateField (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 &, const bool interpolate=false)
	Construct from name, mesh. More...

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

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

virtual	~sampledSurface ()
	Destructor. More...

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

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

bool	interpolate () const
	Interpolation requested for surface. More...

virtual const vectorField &	Sf () const
	Return face area vectors. More...

virtual const scalarField &	magSf () const
	Return face area magnitudes. More...

virtual const vectorField &	Cf () const
	Return face centres as vectorField. More...

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

template<class Type >
Type	integrate (const Field< Type > &) const
	Integration of a field across the surface. More...

template<class Type >
Type	integrate (const tmp< Field< Type > > &) const
	Integration of a field across the surface. More...

template<class Type >
Type	average (const Field< Type > &) const
	Area-averaged value of a field across the surface. More...

template<class Type >
Type	average (const tmp< Field< Type > > &) const
	Area-averaged value of a field across the surface. More...

tmp< Field< scalar > >	project (const Field< scalar > &) const
	Project field onto surface. More...

tmp< Field< scalar > >	project (const Field< vector > &) const
	Project field onto surface. More...

tmp< Field< vector > >	project (const Field< sphericalTensor > &) const
	Project field onto surface. More...

tmp< Field< vector > >	project (const Field< symmTensor > &) const
	Project field onto surface. More...

tmp< Field< vector > >	project (const Field< tensor > &) const
	Project field onto surface. More...

template<class Type >
tmp< GeometricField< Type, fvPatchField, volMesh > >	pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) const
	Interpolate from points to cell centre. More...

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

template<class ReturnType , class Type >
Foam::tmp< Foam::Field< ReturnType > >	project (const tmp< Field< Type > > &field) const

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

Private Member Functions
void	getIsoFields () const
	Get fields needed to recreate iso surface. More...

bool	updateGeometry () const
	Create iso surface (if time has changed) More...

template<class Type >
tmp< Field< Type > >	sampleField (const GeometricField< Type, fvPatchField, volMesh > &vField) const
	Sample field on faces. More...

template<class Type >
tmp< Field< Type > >	interpolateField (const interpolation< Type > &) const

Private Attributes
const word	isoField_
	Field to get isoSurface of. More...

const scalar	isoVal_
	Iso value. More...

const boundBox	bounds_
	Optional bounding box to trim triangles against. More...

const scalar	mergeTol_
	Merge tolerance. More...

const Switch	regularise_
	Whether to coarse. More...

const Switch	average_
	Whether to recalculate cell values as average of point values. More...

cellZoneID	zoneID_
	Zone name/index (if restricted to zones) More...

word	exposedPatchName_
	For zones: patch to put exposed faces into. More...

autoPtr< isoSurface >	surfPtr_

autoPtr< faceList >	facesPtr_
	Triangles converted to faceList. More...

label	prevTimeIndex_
	Time at last call, also track if surface needs an update. More...

autoPtr< volScalarField >	storedVolFieldPtr_
	Cached volfield. More...

const volScalarField *	volFieldPtr_

const pointScalarField *	pointFieldPtr_
	Cached pointfield. More...

autoPtr< fvMeshSubset >	subMeshPtr_
	Cached submesh. More...

autoPtr< volScalarField >	storedVolSubFieldPtr_
	Cached volfield. More...

const volScalarField *	volSubFieldPtr_

const pointScalarField *	pointSubFieldPtr_
	Cached pointfield. More...

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

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

Detailed Description

A sampledSurface defined by a surface of iso value. Always triangulated. To be used in sampleSurfaces / functionObjects. Recalculates iso surface only if time changes.

Source files

Definition at line 53 of file sampledIsoSurface.H.

Constructor & Destructor Documentation

◆ sampledIsoSurface()

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

Construct from dictionary.

Definition at line 455 of file sampledIsoSurface.C.

References polyMesh::boundaryMesh(), dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, polyBoundaryMesh::findPatchID(), Foam::Info, sampledSurface::interpolate(), dictionary::lookup(), mesh, and polyBoundaryMesh::names().

Here is the call graph for this function:

◆ ~sampledIsoSurface()

~sampledIsoSurface ( )

virtual

Destructor.

Definition at line 513 of file sampledIsoSurface.C.

Member Function Documentation

◆ getIsoFields()

void getIsoFields ( ) const

private

Get fields needed to recreate iso surface.

Definition at line 48 of file sampledIsoSurface.C.

Here is the call graph for this function:

◆ updateGeometry()

bool updateGeometry ( ) const

private

Create iso surface (if time has changed)

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

Definition at line 345 of file sampledIsoSurface.C.

References polyMesh::boundaryMesh(), polyMesh::cellZones(), Foam::endl(), Foam::Info, mesh, Foam::nl, patches, points, Foam::Pout, fvMesh::time(), and TimeState::timeIndex().

Here is the call graph for this function:

◆ sampleField() [1/2]

tmp<Field<Type> > sampleField ( const GeometricField< Type, fvPatchField, volMesh > & vField ) const

private

Sample field on faces.

◆ interpolateField() [1/2]

tmp<Field<Type> > interpolateField ( const interpolation< Type > & ) const

private

◆ TypeName()

TypeName ( "sampledIsoSurface" )

Runtime type information.

◆ needsUpdate()

bool needsUpdate ( ) const

virtual

Does the surface need an update?

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledIsoSurface()

◆ ~sampledIsoSurface()

Member Function Documentation

◆ getIsoFields()

◆ updateGeometry()

◆ sampleField() [1/2]

◆ interpolateField() [1/2]

◆ TypeName()

◆ needsUpdate()

◆ expire()

◆ update()

◆ points()

◆ faces()

◆ surface()

◆ getIsoField()

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

◆ sampleField() [2/2]

◆ interpolateField() [2/2]

Field Documentation

◆ isoField_

◆ isoVal_

◆ bounds_

◆ mergeTol_

◆ regularise_

◆ average_

◆ zoneID_

◆ exposedPatchName_

◆ surfPtr_

◆ facesPtr_

◆ prevTimeIndex_

◆ storedVolFieldPtr_

◆ volFieldPtr_

◆ pointFieldPtr_

◆ subMeshPtr_

◆ storedVolSubFieldPtr_

◆ volSubFieldPtr_

◆ pointSubFieldPtr_