distanceSurface Class Reference

A sampledSurface defined by a distance to a surface. More...

Inheritance diagram for distanceSurface:

[legend]

Collaboration diagram for distanceSurface:

[legend]

List of all members.

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

Source files

• distanceSurface.H
• distanceSurface.C

Definition at line 47 of file distanceSurface.H.

---

Constructor & Destructor Documentation

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

Construct from dictionary.

Definition at line 251 of file distanceSurface.C.

~distanceSurface

(

)

[virtual]

Definition at line 298 of file distanceSurface.C.

---

Member Function Documentation

TypeName

(

"distanceSurface"

)

Runtime type information.

bool needsUpdate

(

)

const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 304 of file distanceSurface.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 310 of file distanceSurface.C.

bool update

(

)

[virtual]

Update the surface as required.

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

Implements sampledSurface.

Definition at line 333 of file distanceSurface.C.

virtual const pointField& points

(

)

const [inline, virtual]

Points of surface.

Implements sampledSurface.

Definition at line 144 of file distanceSurface.H.

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

Here is the call graph for this function:

virtual const faceList& faces

(

)

const [inline, virtual]

Faces of surface.

Implements sampledSurface.

Definition at line 150 of file distanceSurface.H.

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

Here is the call graph for this function:

const isoSurface& surface

(

)

const [inline]

Definition at line 167 of file distanceSurface.H.

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

Here is the caller graph for this function:

Foam::tmp< Foam::scalarField > sample

(

const volScalarField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 356 of file distanceSurface.C.

Foam::tmp< Foam::vectorField > sample

(

const volVectorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 366 of file distanceSurface.C.

Foam::tmp< Foam::sphericalTensorField > sample

(

const volSphericalTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 376 of file distanceSurface.C.

Foam::tmp< Foam::symmTensorField > sample

(

const volSymmTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 386 of file distanceSurface.C.

Foam::tmp< Foam::tensorField > sample

(

const volTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 396 of file distanceSurface.C.

Foam::tmp< Foam::scalarField > interpolate

(

const interpolation< scalar > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 406 of file distanceSurface.C.

Foam::tmp< Foam::vectorField > interpolate

(

const interpolation< vector > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 416 of file distanceSurface.C.

Foam::tmp< Foam::sphericalTensorField > interpolate

(

const interpolation< sphericalTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 425 of file distanceSurface.C.

Foam::tmp< Foam::symmTensorField > interpolate

(

const interpolation< symmTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 435 of file distanceSurface.C.

Foam::tmp< Foam::tensorField > interpolate

(

const interpolation< tensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 445 of file distanceSurface.C.

void print

(

Ostream &

os

)

const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 453 of file distanceSurface.C.

---

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

• src/sampling/sampledSurface/distanceSurface/distanceSurface.H
• src/sampling/sampledSurface/distanceSurface/distanceSurface.C
• src/sampling/sampledSurface/distanceSurface/distanceSurfaceTemplates.C