sampledCuttingPlane Class Reference

A sampledSurface defined by a plane. More...

Inheritance diagram for sampledCuttingPlane:

[legend]

Collaboration diagram for sampledCuttingPlane:

[legend]

List of all members.

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

Source files

• sampledCuttingPlane.H
• sampledCuttingPlane.C

Definition at line 48 of file sampledCuttingPlane.H.

---

Constructor & Destructor Documentation

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

Construct from dictionary.

Definition at line 238 of file sampledCuttingPlane.C.

~sampledCuttingPlane

(

)

[virtual]

Definition at line 284 of file sampledCuttingPlane.C.

---

Member Function Documentation

TypeName

(

"sampledCuttingPlane"

)

Runtime type information.

bool needsUpdate

(

)

const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 290 of file sampledCuttingPlane.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 296 of file sampledCuttingPlane.C.

bool update

(

)

[virtual]

Update the surface as required.

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

Implements sampledSurface.

Definition at line 319 of file sampledCuttingPlane.C.

virtual const pointField& points

(

)

const [inline, virtual]

Points of surface.

Implements sampledSurface.

Definition at line 148 of file sampledCuttingPlane.H.

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

Here is the call graph for this function:

virtual const faceList& faces

(

)

const [inline, virtual]

Faces of surface.

Implements sampledSurface.

Definition at line 154 of file sampledCuttingPlane.H.

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

Here is the call graph for this function:

const isoSurface& surface

(

)

const [inline]

Definition at line 171 of file sampledCuttingPlane.H.

Referenced by sampledCuttingPlane::faces(), and sampledCuttingPlane::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 342 of file sampledCuttingPlane.C.

Foam::tmp< Foam::vectorField > sample

(

const volVectorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 352 of file sampledCuttingPlane.C.

Foam::tmp< Foam::sphericalTensorField > sample

(

const volSphericalTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 362 of file sampledCuttingPlane.C.

Foam::tmp< Foam::symmTensorField > sample

(

const volSymmTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 372 of file sampledCuttingPlane.C.

Foam::tmp< Foam::tensorField > sample

(

const volTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 382 of file sampledCuttingPlane.C.

Foam::tmp< Foam::scalarField > interpolate

(

const interpolation< scalar > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 392 of file sampledCuttingPlane.C.

Foam::tmp< Foam::vectorField > interpolate

(

const interpolation< vector > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 402 of file sampledCuttingPlane.C.

Foam::tmp< Foam::sphericalTensorField > interpolate

(

const interpolation< sphericalTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 411 of file sampledCuttingPlane.C.

Foam::tmp< Foam::symmTensorField > interpolate

(

const interpolation< symmTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 421 of file sampledCuttingPlane.C.

Foam::tmp< Foam::tensorField > interpolate

(

const interpolation< tensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 431 of file sampledCuttingPlane.C.

void print

(

Ostream &

os

)

const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 439 of file sampledCuttingPlane.C.

---

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

• src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlane.H
• src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlane.C
• src/sampling/sampledSurface/sampledCuttingPlane/sampledCuttingPlaneTemplates.C