sampledIsoSurfaceCell 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 sampledIsoSurfaceCell:

[legend]

Collaboration diagram for sampledIsoSurfaceCell:

[legend]

List of all members.

Public Member Functions
	TypeName ("sampledIsoSurfaceCell")
	Runtime type information.
	sampledIsoSurfaceCell (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary.
virtual	~sampledIsoSurfaceCell ()
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.
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

• sampledIsoSurfaceCell.H
• sampledIsoSurfaceCell.C

Definition at line 47 of file sampledIsoSurfaceCell.H.

---

Constructor & Destructor Documentation

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

Construct from dictionary.

Definition at line 183 of file sampledIsoSurfaceCell.C.

~sampledIsoSurfaceCell

(

)

[virtual]

Definition at line 214 of file sampledIsoSurfaceCell.C.

---

Member Function Documentation

TypeName

(

"sampledIsoSurfaceCell"

)

Runtime type information.

bool needsUpdate

(

)

const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 220 of file sampledIsoSurfaceCell.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 228 of file sampledIsoSurfaceCell.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 244 of file sampledIsoSurfaceCell.C.

virtual const pointField& points

(

)

const [inline, virtual]

Points of surface.

Implements sampledSurface.

Definition at line 145 of file sampledIsoSurfaceCell.H.

virtual const faceList& faces

(

)

const [inline, virtual]

Faces of surface.

Implements sampledSurface.

Definition at line 151 of file sampledIsoSurfaceCell.H.

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

Here is the call graph for this function:

Foam::tmp< Foam::scalarField > sample

(

const volScalarField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 252 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::vectorField > sample

(

const volVectorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 262 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::sphericalTensorField > sample

(

const volSphericalTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 272 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::symmTensorField > sample

(

const volSymmTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 282 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::tensorField > sample

(

const volTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 292 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::scalarField > interpolate

(

const interpolation< scalar > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 302 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::vectorField > interpolate

(

const interpolation< vector > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 312 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::sphericalTensorField > interpolate

(

const interpolation< sphericalTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 321 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::symmTensorField > interpolate

(

const interpolation< symmTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 331 of file sampledIsoSurfaceCell.C.

Foam::tmp< Foam::tensorField > interpolate

(

const interpolation< tensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 341 of file sampledIsoSurfaceCell.C.

void print

(

Ostream &

os

)

const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 349 of file sampledIsoSurfaceCell.C.

---

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

• src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.H
• src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCell.C
• src/sampling/sampledSurface/isoSurface/sampledIsoSurfaceCellTemplates.C