sampledPlane Class Reference

A sampledSurface defined by a cuttingPlane. Always triangulated. More...

Inheritance diagram for sampledPlane:

[legend]

Collaboration diagram for sampledPlane:

[legend]

List of all members.

Public Member Functions
	TypeName ("sampledPlane")
	Runtime type information.
	sampledPlane (const word &name, const polyMesh &mesh, const plane &planeDesc, const word &zoneName=word::null)
	Construct from components.
	sampledPlane (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary.
virtual	~sampledPlane ()
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 labelList &	meshCells () const
	For every face original cell in mesh.
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 cuttingPlane. Always triangulated.

Source files

• sampledPlane.H
• sampledPlane.C

Definition at line 45 of file sampledPlane.H.

---

Constructor & Destructor Documentation

sampledPlane	(	const word &	name,
		const polyMesh &	mesh,
		const plane &	planeDesc,
		const word &	zoneName = word::null
	)

Construct from components.

Definition at line 36 of file sampledPlane.C.

References Foam::addNamedToRunTimeSelectionTable(), and Foam::defineTypeNameAndDebug().

Here is the call graph for this function:

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

Construct from dictionary.

Definition at line 60 of file sampledPlane.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

~sampledPlane

(

)

[virtual]

Definition at line 100 of file sampledPlane.C.

---

Member Function Documentation

TypeName

(

"sampledPlane"

)

Runtime type information.

bool needsUpdate

(

)

const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 106 of file sampledPlane.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 112 of file sampledPlane.C.

bool update

(

)

[virtual]

Update the surface as required.

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

Implements sampledSurface.

Definition at line 127 of file sampledPlane.C.

virtual const pointField& points

(

)

const [inline, virtual]

Points of surface.

Implements sampledSurface.

Definition at line 124 of file sampledPlane.H.

virtual const faceList& faces

(

)

const [inline, virtual]

Faces of surface.

Implements sampledSurface.

Definition at line 130 of file sampledPlane.H.

const labelList& meshCells

(

)

const [inline]

For every face original cell in mesh.

Definition at line 136 of file sampledPlane.H.

References cuttingPlane::cutCells().

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 164 of file sampledPlane.C.

Foam::tmp< Foam::vectorField > sample

(

const volVectorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 174 of file sampledPlane.C.

Foam::tmp< Foam::sphericalTensorField > sample

(

const volSphericalTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 184 of file sampledPlane.C.

Foam::tmp< Foam::symmTensorField > sample

(

const volSymmTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 194 of file sampledPlane.C.

Foam::tmp< Foam::tensorField > sample

(

const volTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 204 of file sampledPlane.C.

Foam::tmp< Foam::scalarField > interpolate

(

const interpolation< scalar > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 214 of file sampledPlane.C.

Foam::tmp< Foam::vectorField > interpolate

(

const interpolation< vector > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 224 of file sampledPlane.C.

Foam::tmp< Foam::sphericalTensorField > interpolate

(

const interpolation< sphericalTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 233 of file sampledPlane.C.

Foam::tmp< Foam::symmTensorField > interpolate

(

const interpolation< symmTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 243 of file sampledPlane.C.

Foam::tmp< Foam::tensorField > interpolate

(

const interpolation< tensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 253 of file sampledPlane.C.

void print

(

Ostream &

os

)

const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 261 of file sampledPlane.C.

---

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

• src/sampling/sampledSurface/sampledPlane/sampledPlane.H
• src/sampling/sampledSurface/sampledPlane/sampledPlane.C
• src/sampling/sampledSurface/sampledPlane/sampledPlaneTemplates.C