sampledIsoSurface Class Reference

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:

Collaboration diagram for sampledIsoSurface:

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 tmp< scalarField >	sample (const surfaceScalarField &) const
	Surface sample field on surface. More...
virtual tmp< vectorField >	sample (const surfaceVectorField &) const
	Surface Sample field on surface. More...
virtual tmp< sphericalTensorField >	sample (const surfaceSphericalTensorField &) const
	Surface sample field on surface. 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

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

• sampledIsoSurface.H
• sampledIsoSurface.C

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 438 of file sampledIsoSurface.C.

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

Here is the call graph for this function:

~sampledIsoSurface()

~sampledIsoSurface ( )

virtual

Destructor.

Definition at line 495 of file sampledIsoSurface.C.

Member Function Documentation

TypeName()

TypeName

(

"sampledIsoSurface"

)

Runtime type information.

needsUpdate()

bool needsUpdate ( ) const

virtual

Does the surface need an update?

Implements sampledSurface.

Definition at line 501 of file sampledIsoSurface.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 509 of file sampledIsoSurface.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 530 of file sampledIsoSurface.C.

References sampledIsoSurface::sample().

Here is the call graph for this function:

points()

virtual const pointField& points ( ) const

inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 172 of file sampledIsoSurface.H.

References PrimitivePatch< Face, FaceList, PointField, PointType >::points(), and sampledIsoSurface::surface().

Here is the call graph for this function:

faces()

virtual const faceList& faces ( ) const

inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 178 of file sampledIsoSurface.H.

References autoPtr< T >::empty(), forAll, autoPtr< T >::reset(), s(), List< T >::size(), and sampledIsoSurface::surface().

Here is the call graph for this function:

surface()

const isoSurface& surface ( ) const

inline

Definition at line 195 of file sampledIsoSurface.H.

References sampledIsoSurface::getIsoField(), sampledSurface::interpolate(), sampledIsoSurface::print(), and sampledIsoSurface::sample().

Referenced by sampledIsoSurface::faces(), and sampledIsoSurface::points().

Here is the call graph for this function:

Here is the caller graph for this function:

getIsoField()

void getIsoField

(

)

Lookup or read isoField. Sets volFieldPtr_ and pointFieldPtr_.

Referenced by sampledIsoSurface::surface().

Here is the caller graph for this function:

sample() [1/5]

Foam::tmp< Foam::scalarField > sample ( const volScalarField &  vField ) const

virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 537 of file sampledIsoSurface.C.

Referenced by sampledIsoSurface::sample(), sampledIsoSurface::surface(), and sampledIsoSurface::update().

Here is the caller graph for this function:

sample() [2/5]

Foam::tmp< Foam::vectorField > sample ( const volVectorField &  vField ) const

virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 546 of file sampledIsoSurface.C.

References sampledIsoSurface::sample().

Here is the call graph for this function:

sample() [3/5]

Foam::tmp< Foam::sphericalTensorField > sample ( const volSphericalTensorField &  vField ) const

virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 555 of file sampledIsoSurface.C.

References sampledIsoSurface::sample().

Here is the call graph for this function:

sample() [4/5]

Foam::tmp< Foam::symmTensorField > sample ( const volSymmTensorField &  vField ) const

virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 564 of file sampledIsoSurface.C.

References sampledIsoSurface::sample().

Here is the call graph for this function:

sample() [5/5]

Foam::tmp< Foam::tensorField > sample ( const volTensorField &  vField ) const

virtual

Sample field on surface.

Implements sampledSurface.

Definition at line 573 of file sampledIsoSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

interpolate() [1/5]

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

virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 582 of file sampledIsoSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

interpolate() [2/5]

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

virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 591 of file sampledIsoSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

interpolate() [3/5]

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

virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 599 of file sampledIsoSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

interpolate() [4/5]

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

virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 608 of file sampledIsoSurface.C.

References sampledSurface::interpolate().

Here is the call graph for this function:

interpolate() [5/5]

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

virtual

Interpolate field on surface.

Implements sampledSurface.

Definition at line 617 of file sampledIsoSurface.C.

print()

void print ( Ostream &  os ) const

virtual

Write.

Reimplemented from sampledSurface.

Definition at line 625 of file sampledIsoSurface.C.

References Foam::name().

Referenced by sampledIsoSurface::surface().

Here is the call graph for this function:

Here is the caller graph for this function:

sampleField()

Foam::tmp<Foam::Field<Type> > sampleField

(

const GeometricField< Type, fvPatchField, volMesh > &

vField

)

const

Definition at line 36 of file sampledIsoSurfaceTemplates.C.

interpolateField()

Foam::tmp<Foam::Field<Type> > interpolateField

(

const interpolation< Type > &

interpolator

)

const

Definition at line 50 of file sampledIsoSurfaceTemplates.C.

References Foam::fvc::interpolate(), DimensionedField< Type, GeoMesh >::mesh(), Foam::New(), and interpolation< Type >::psi().

Here is the call graph for this function:

---

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

• src/sampling/sampledSurface/isoSurface/sampledIsoSurface.H
• src/sampling/sampledSurface/isoSurface/sampledIsoSurface.C
• src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceTemplates.C