sampledPatch Class Reference

A sampledSurface on a patch. Non-triangulated by default. More...

Inheritance diagram for sampledPatch:

[legend]

Collaboration diagram for sampledPatch:

[legend]

List of all members.

Public Member Functions
	TypeName ("sampledPatch")
	Runtime type information.
	sampledPatch (const word &name, const polyMesh &mesh, const word &patchName, const bool triangulate=false)
	Construct from components.
	sampledPatch (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary.
virtual	~sampledPatch ()
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.
const word	patchName () const
label	patchIndex () const
const labelList &	patchFaceLabels () const
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 on a patch. Non-triangulated by default.

Source files

• sampledPatch.H
• sampledPatch.C

Definition at line 45 of file sampledPatch.H.

---

Constructor & Destructor Documentation

sampledPatch	(	const word &	name,
		const polyMesh &	mesh,
		const word &	patchName,
		const bool	triangulate = false
	)

Construct from components.

Definition at line 38 of file sampledPatch.C.

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

Here is the call graph for this function:

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

Construct from dictionary.

Definition at line 54 of file sampledPatch.C.

~sampledPatch

(

)

[virtual]

Definition at line 70 of file sampledPatch.C.

---

Member Function Documentation

TypeName

(

"sampledPatch"

)

Runtime type information.

bool needsUpdate

(

)

const [virtual]

Does the surface need an update?

Implements sampledSurface.

Definition at line 76 of file sampledPatch.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 82 of file sampledPatch.C.

bool update

(

)

[virtual]

Update the surface as required.

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

Implements sampledSurface.

Definition at line 99 of file sampledPatch.C.

const word patchName

(

)

const [inline]

Definition at line 136 of file sampledPatch.H.

label patchIndex

(

)

const [inline]

Definition at line 141 of file sampledPatch.H.

const labelList& patchFaceLabels

(

)

const [inline]

Definition at line 146 of file sampledPatch.H.

virtual const pointField& points

(

)

const [inline, virtual]

Points of surface.

Implements sampledSurface.

Definition at line 152 of file sampledPatch.H.

References PrimitivePatch< face,::Foam::List, pointField, point >::points().

Here is the call graph for this function:

virtual const faceList& faces

(

)

const [inline, virtual]

Faces of surface.

Implements sampledSurface.

Definition at line 158 of file sampledPatch.H.

References MeshedSurface< face >::faces().

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 159 of file sampledPatch.C.

References MeshedSurface< face >::remapFaces().

Here is the call graph for this function:

Foam::tmp< Foam::vectorField > sample

(

const volVectorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 169 of file sampledPatch.C.

Foam::tmp< Foam::sphericalTensorField > sample

(

const volSphericalTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 178 of file sampledPatch.C.

Foam::tmp< Foam::symmTensorField > sample

(

const volSymmTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 188 of file sampledPatch.C.

Foam::tmp< Foam::tensorField > sample

(

const volTensorField &

vField

)

const [virtual]

sample field on surface

Implements sampledSurface.

Definition at line 198 of file sampledPatch.C.

Foam::tmp< Foam::scalarField > interpolate

(

const interpolation< scalar > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 208 of file sampledPatch.C.

Foam::tmp< Foam::vectorField > interpolate

(

const interpolation< vector > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 218 of file sampledPatch.C.

Foam::tmp< Foam::sphericalTensorField > interpolate

(

const interpolation< sphericalTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 227 of file sampledPatch.C.

Foam::tmp< Foam::symmTensorField > interpolate

(

const interpolation< symmTensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 237 of file sampledPatch.C.

Foam::tmp< Foam::tensorField > interpolate

(

const interpolation< tensor > &

interpolator

)

const [virtual]

interpolate field on surface

Implements sampledSurface.

Definition at line 247 of file sampledPatch.C.

void print

(

Ostream &

os

)

const [virtual]

Write.

Reimplemented from sampledSurface.

Definition at line 255 of file sampledPatch.C.

---

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

• src/sampling/sampledSurface/sampledPatch/sampledPatch.H
• src/sampling/sampledSurface/sampledPatch/sampledPatch.C
• src/sampling/sampledSurface/sampledPatch/sampledPatchTemplates.C