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:

[legend]

Collaboration diagram for sampledIsoSurface:

[legend]

List of all members.

Public Member Functions
	TypeName ("sampledIsoSurface")
	Runtime type information.
	sampledIsoSurface (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary.
virtual	~sampledIsoSurface ()
virtual bool	needsUpdate () const
	Does the surface need an update?
virtual bool	expire ()
	Mark the surface as needing an update.
virtual bool	update ()
	Update the surface as required.
virtual const pointField &	points () const
	Points of surface.
virtual const faceList &	faces () const
	Faces of surface.
const isoSurface &	surface () const
void	getIsoField ()
	Lookup or read isoField. Sets volFieldPtr_ and pointFieldPtr_.
virtual tmp< scalarField >	sample (const volScalarField &) const
	sample field on surface
virtual tmp< vectorField >	sample (const volVectorField &) const
	sample field on surface
virtual tmp< sphericalTensorField >	sample (const volSphericalTensorField &) const
	sample field on surface
virtual tmp< symmTensorField >	sample (const volSymmTensorField &) const
	sample field on surface
virtual tmp< tensorField >	sample (const volTensorField &) const
	sample field on surface
virtual tmp< scalarField >	interpolate (const interpolation< scalar > &) const
	interpolate field on surface
virtual tmp< vectorField >	interpolate (const interpolation< vector > &) const
	interpolate field on surface
virtual tmp< sphericalTensorField >	interpolate (const interpolation< sphericalTensor > &) const
	interpolate field on surface
virtual tmp< symmTensorField >	interpolate (const interpolation< symmTensor > &) const
	interpolate field on surface
virtual tmp< tensorField >	interpolate (const interpolation< tensor > &) const
	interpolate field on surface
virtual void	print (Ostream &) const
	Write.

---

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 49 of file sampledIsoSurface.H.

---

Constructor & Destructor Documentation

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

Construct from dictionary.

Definition at line 474 of file sampledIsoSurface.C.

~sampledIsoSurface

(

)

[virtual]

Definition at line 536 of file sampledIsoSurface.C.

---

Member Function Documentation

TypeName

(

"sampledIsoSurface"

)

Runtime type information.

bool needsUpdate

(

)

const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 542 of file sampledIsoSurface.C.

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

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

Here is the call graph for this function:

bool update

(

)

[virtual]

Update the surface as required.

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

Implements sampledSurface.

Definition at line 568 of file sampledIsoSurface.C.

virtual const pointField& points

(

)

const [inline, virtual]

Points of surface.

Implements sampledSurface.

Definition at line 188 of file sampledIsoSurface.H.

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

Here is the call graph for this function:

virtual const faceList& faces

(

)

const [inline, virtual]

Faces of surface.

Implements sampledSurface.

Definition at line 194 of file sampledIsoSurface.H.

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

Here is the call graph for this function:

const isoSurface& surface

(

)

const [inline]

Definition at line 211 of file sampledIsoSurface.H.

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

Here is the caller graph for this function:

void getIsoField

(

)

Lookup or read isoField. Sets volFieldPtr_ and pointFieldPtr_.

Foam::tmp< Foam::sphericalTensorField > sample

(

const volScalarField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 575 of file sampledIsoSurface.C.

Foam::tmp< Foam::vectorField > sample

(

const volVectorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 584 of file sampledIsoSurface.C.

virtual tmp<sphericalTensorField> sample

(

const volSphericalTensorField &

)

const [virtual]

sample field on surface

Implements sampledSurface.

Foam::tmp< Foam::symmTensorField > sample

(

const volSymmTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 602 of file sampledIsoSurface.C.

Foam::tmp< Foam::tensorField > sample

(

const volTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 611 of file sampledIsoSurface.C.

Foam::tmp< Foam::scalarField > interpolate

(

const interpolation< scalar > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 620 of file sampledIsoSurface.C.

Foam::tmp< Foam::vectorField > interpolate

(

const interpolation< vector > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 629 of file sampledIsoSurface.C.

Foam::tmp< Foam::sphericalTensorField > interpolate

(

const interpolation< sphericalTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 637 of file sampledIsoSurface.C.

Foam::tmp< Foam::symmTensorField > interpolate

(

const interpolation< symmTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 646 of file sampledIsoSurface.C.

Foam::tmp< Foam::tensorField > interpolate

(

const interpolation< tensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 655 of file sampledIsoSurface.C.

void print

(

Ostream &

os

)

const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 663 of file sampledIsoSurface.C.

---

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