A sampledSurface on patches. Non-triangulated by default. More...

Inheritance diagram for sampledPatch:

Collaboration diagram for sampledPatch:

Public Member Functions
	TypeName ("sampledPatch")
	Runtime type information. More...

	sampledPatch (const word &name, const polyMesh &mesh, const UList< wordRe > &patchNames, const bool triangulate=false)
	Construct from components. More...

	sampledPatch (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

virtual	~sampledPatch ()=default
	Destructor. More...

virtual bool	needsUpdate () const
	Does the surface need an update? More...

virtual bool	expire ()
	Mark the surface as needing an update. More...

virtual bool	update ()
	Update the surface as required. More...

virtual const pointField &	points () const
	Points of surface. More...

virtual const faceList &	faces () const
	Faces of surface. More...

virtual const labelList &	zoneIds () const
	Per-face zone/region information. More...

virtual const vectorField &	Sf () const
	Face area vectors. More...

virtual const scalarField &	magSf () const
	Face area magnitudes. More...

virtual const vectorField &	Cf () const
	Face centres. More...

virtual tmp< scalarField >	sample (const interpolation< scalar > &sampler) const
	Sample boundary of volume field onto surface faces. More...

virtual tmp< vectorField >	sample (const interpolation< vector > &sampler) const
	Sample boundary of volume field onto surface faces. More...

virtual tmp< sphericalTensorField >	sample (const interpolation< sphericalTensor > &sampler) const
	Sample boundary of volume field onto surface faces. More...

virtual tmp< symmTensorField >	sample (const interpolation< symmTensor > &sampler) const
	Sample boundary of volume field onto surface faces. More...

virtual tmp< tensorField >	sample (const interpolation< tensor > &sampler) const
	Sample boundary of volume field onto surface faces. More...

virtual bool	withSurfaceFields () const
	Can it sample surface-fields? More...

virtual tmp< scalarField >	sample (const surfaceScalarField &) const
	Sample boundary of surface field on surface. More...

virtual tmp< vectorField >	sample (const surfaceVectorField &) const
	Sample boundary of surface field on surface. More...

virtual tmp< sphericalTensorField >	sample (const surfaceSphericalTensorField &) const
	Sample boundary of surface field on surface. More...

virtual tmp< symmTensorField >	sample (const surfaceSymmTensorField &) const
	Sample boundary of surface field on surface. More...

virtual tmp< tensorField >	sample (const surfaceTensorField &) const
	Sample boundary of surface field on surface. More...

virtual tmp< scalarField >	interpolate (const interpolation< scalar > &interpolator) const
	Interpolate boundary of volume field onto surface points. More...

virtual tmp< vectorField >	interpolate (const interpolation< vector > &interpolator) const
	Interpolate boundary of volume field onto surface points. More...

virtual tmp< sphericalTensorField >	interpolate (const interpolation< sphericalTensor > &interpolator) const
	Interpolate boundary of volume field onto surface points. More...

virtual tmp< symmTensorField >	interpolate (const interpolation< symmTensor > &interpolator) const
	Interpolate boundary of volume field onto surface points. More...

virtual tmp< tensorField >	interpolate (const interpolation< tensor > &interpolator) const
	Interpolate boundary of volume field onto surface points. More...

virtual void	print (Ostream &os, int level=0) const
	Print information. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnFaces (const GeometricField< Type, fvsPatchField, surfaceMesh > &sField) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnPoints (const interpolation< Type > &interpolator) const

Public Member Functions inherited from MeshedSurface< Face >
	ClassName ("MeshedSurface")
	Declare type-name (with debug switch) More...

	MeshedSurface ()
	Default construct, an empty surface. More...

	MeshedSurface (const MeshedSurface &surf)
	Copy construct. More...

	MeshedSurface (const UnsortedMeshedSurface< Face > &surf)
	Copy construct from an UnsortedMeshedSurface. More...

	MeshedSurface (MeshedSurface &&surf)
	Move construct. More...

	MeshedSurface (UnsortedMeshedSurface< Face > &&surf)
	Move construct from an UnsortedMeshedSurface. More...

	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst)
	Copy construct from components (points, faces, zones). More...

	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst)
	Move construct from components (points, faces). More...

	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Copy construct from components (points, faces). More...

	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Move construct from components (points, faces). More...

	MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false)
	Construct from a boundary mesh with local points/faces. More...

	MeshedSurface (const surfMesh &mesh)
	Construct from a surfMesh. More...

	MeshedSurface (const fileName &name)
	Construct from file name (uses extension to determine type) More...

	MeshedSurface (const fileName &name, const word &fileType)
	Construct from file name and given file type. More...

	MeshedSurface (Istream &is)
	Construct from Istream. More...

	MeshedSurface (const Time &runTime)
	Construct from database (as surfMesh) with default name. More...

	MeshedSurface (const Time &runTime, const word &surfName)
	Construct from database (as surfMesh) with given surface name. More...

	MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true)
	Read construct using IO to find the file location. More...

	declareRunTimeSelectionTable (autoPtr, MeshedSurface, fileExtension,(const fileName &name),(name))

virtual	~MeshedSurface ()
	Destructor. More...

	declareMemberFunctionSelectionTable (void, UnsortedMeshedSurface, write, fileExtension,(const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt, const dictionary &options),(name, surf, streamOpt, options))

label	size () const
	The surface size is the number of faces. More...

const List< Face > &	surfFaces () const
	Return const access to the faces. More...

const labelList &	faceIds () const
	Return const access to faces ids. More...

const surfZoneList &	surfZones () const
	Const access to the surface zones. More...

const vectorField &	Sf () const
	Face area vectors (normals) More...

const scalarField &	magSf () const
	Face area magnitudes. More...

const vectorField &	Cf () const
	Face centres. More...

virtual void	clear ()
	Clear all storage. More...

virtual void	addZones (const UList< surfZone > &, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)
	Add surface zones. More...

virtual void	addZones (const labelUList &sizes, const bool cullEmpty=false)
	Add surface zones. More...

bool	addZonesToFaces ()
	Propagate zone information on face regions. More...

virtual void	removeZones ()
	Remove surface zones. More...

virtual void	movePoints (const pointField &newPoints)
	Move points. More...

virtual void	scalePoints (const scalar scaleFactor)
	Scale points. A non-positive factor is ignored. More...

virtual void	cleanup (const bool verbose)
	Remove invalid faces. More...

virtual void	compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null()))
	Remove unused points and renumber faces in local visit order. More...

virtual bool	stitchFaces (const scalar tol=SMALL, const bool verbose=false)

virtual bool	checkFaces (const bool verbose=false)

virtual label	nTriangles () const
	Count number of triangles. More...

virtual label	nTriangles (labelList &faceMap) const
	Count number of triangles, returning a face map of original ids. More...

virtual label	triangulate ()
	Triangulate in-place, returning the number of triangles added. More...

virtual label	triangulate (labelList &faceMap)
	Triangulate in-place, returning the number of triangles added. More...

template<class BoolListType >
void	subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const
	Create mappings for a sub-surface. More...

MeshedSurface	subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const
	Return a new surface subsetted on the selected faces. More...

MeshedSurface	subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const
	Return a new surface subsetted on the selected faces. More...

MeshedSurface	subsetMesh (const UList< bool > &include) const
	Return a new surface subsetted on the selected faces. More...

MeshedSurface	subsetMesh (const bitSet &include) const
	Return a new surface subsetted on the selected faces. More...

MeshedSurface	subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const
	Return a new surface subsetted on the selected zone names. More...

void	swap (MeshedSurface< Face > &surf)
	Swap contents. More...

void	transfer (pointField &pointLst, List< Face > &faceLst)
	Transfer the components. More...

void	transfer (MeshedSurface< Face > &surf)
	Transfer the contents of the argument and annul the argument. More...

void	transfer (UnsortedMeshedSurface< Face > &surf)
	Transfer the contents of the argument and annul the argument. More...

autoPtr< MeshedSurface< Face > >	releaseGeom ()
	Release (clear) geometry and return for reuse. More...

void	swapFaces (List< Face > &faces)
	Swap the stored faces. Use with caution. More...

void	swapPoints (pointField &points)
	Swap the stored points. More...

bool	read (const fileName &name, const word &fileType)
	Read from file. Chooses reader based on explicit extension. More...

virtual bool	read (const fileName &name)
	Read from file. Chooses reader based on detected extension. More...

void	writeStats (Ostream &os) const

virtual void	write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
	Generic write routine. Chooses writer based on extension. More...

virtual void	write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const
	Generic write routine for given format type. More...

void	write (const Time &runTime, const word &surfName=word::null) const
	Write to database. More...

void	operator= (const MeshedSurface< Face > &surf)
	Copy assignment. More...

void	operator= (MeshedSurface< Face > &&surf)
	Move assignment. More...

	operator MeshedSurfaceProxy< Face > () const
	Conversion operator to MeshedSurfaceProxy. More...

template<class Face>
	MeshedSurface (const MeshedSurface< Face > &surf)

template<class Face>
	MeshedSurface (MeshedSurface< Face > &&surf)

template<>
bool	addZonesToFaces ()
	Specialization for labelledTri. More...

template<>
bool	addZonesToFaces ()

Public Member Functions inherited from sampledSurface
	TypeName ("sampledSurface")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))
	Declare run-time constructor selection table. More...

	sampledSurface (const word &name, const polyMesh &mesh, const bool interpolateToPoints=false)
	Construct from name, mesh. More...

	sampledSurface (const word &name, const polyMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

autoPtr< sampledSurface >	clone () const
	Clone. More...

virtual	~sampledSurface ()
	Destructor - calls clearGeom() More...

const polyMesh &	mesh () const noexcept
	Access to the underlying mesh. More...

const word &	name () const noexcept
	Name of surface. More...

bool	enabled () const noexcept
	Surface is enabled. More...

bool	invariant () const noexcept
	Surface is invariant with geometry change (caution) More...

bool	isPointData () const noexcept
	Using interpolation to surface points. More...

virtual bool	isPointData (const bool on)
	Change point/cell representation, may trigger an expire(). More...

scalar	area () const
	The total surface area. More...

virtual bool	hasFaceIds () const
	If element ids/order of the original surface are available. More...

polySurface *	getRegistrySurface (const objectRegistry &obr, word lookupName="") const
	Get surface from registry if available. More...

polySurface *	storeRegistrySurface (objectRegistry &obr, word lookupName="") const
	Copy surface into registry. More...

bool	removeRegistrySurface (objectRegistry &obr, word lookupName="") const
	Remove surface from registry. More...

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const
	Copy/store sampled field onto registered surface (if it exists) More...

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const
	Move/store sampled field onto registered surface (if it exists) More...

surfMesh *	getSurfMesh (word lookupName="") const
	Get surface from registry if available. More...

surfMesh *	storeSurfMesh (word lookupName="") const
	Copy surface into registry. More...

bool	removeSurfMesh (word lookupName="") const
	Remove surface from registry. More...

template<class Type , class GeoMeshType >
bool	storeSurfMeshField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const
	Copy/store sampled Face field onto surfMesh (if it exists) More...

template<class Type , class GeoMeshType >
bool	storeSurfMeshField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const
	Move/store sampled Face field onto surfMesh (if it exists) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	interpolate () const noexcept
	Same as isPointData() More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts, const Type &defaultValue)

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts)

template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > >	pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld)

Public Member Functions inherited from meshedSurf
constexpr	meshedSurf () noexcept=default
	Default construct. More...

virtual	~meshedSurf ()=default
	Destructor. More...

virtual const labelList &	faceIds () const
	Per-face identifier (eg, element Id) More...

Protected Member Functions
const wordRes &	patchNames () const
	The selection (word/regex) of patches. More...

const labelList &	patchIDs () const
	The patches selected. More...

const labelList &	patchStart () const
	The offset into patchIndex, patchFaceLabels. More...

const labelList &	patchIndex () const
	For each face, the patch ID. More...

const labelList &	patchFaceLabels () const
	For each face, the patch local face ID. More...

Protected Member Functions inherited from MeshedSurface< Face >
void	transcribe (MeshedSurface< face > &surf)
	Transfer points/zones from 'face' to other other shapes. More...

void	checkZones (const bool verbose=true)
	Sanity check/resizing on zones. More...

pointField &	storedPoints ()
	Non-const access to global points. More...

List< Face > &	storedFaces ()
	Non-const access to the faces. More...

labelList &	storedFaceIds ()
	Non-const access to face ids. More...

surfZoneList &	storedZones ()
	Non-const access to the zones. More...

void	sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted)
	Sort faces by zones and store sorted faces. More...

template<>
void	transcribe (MeshedSurface< face > &surf)

template<>
void	transcribe (MeshedSurface< face > &surf)

template<>
void	transcribe (MeshedSurface< face > &surf)

Protected Member Functions inherited from sampledSurface
virtual void	clearGeom () const
	Additional cleanup when clearing the geometry. More...

	sampledSurface (const word &name, std::nullptr_t)
	Construct null. More...

Additional Inherited Members
Public Types inherited from MeshedSurface< Face >
typedef Face	face_type
	The face type (same as the underlying PrimitivePatch) More...

typedef point	point_type
	The point type (same as the underlying PrimitivePatch) More...

Static Public Member Functions inherited from MeshedSurface< Face >
static wordHashSet	readTypes ()
	Known readable file-types, without friends or proxies. More...

static wordHashSet	writeTypes ()
	Known writable file-types, without friends or proxies. More...

static bool	canReadType (const word &fileType, bool verbose=false)
	Can we read this file format? Also checks friend types. More...

static bool	canWriteType (const word &fileType, bool verbose=false)
	Can we write this file format? Also checks proxy types. More...

static bool	canRead (const fileName &name, bool verbose=false)
	Can we read this file format? More...

static autoPtr< MeshedSurface >	New (const fileName &name, const word &fileType, bool mandatory=true)
	Read construct from filename with given file type. More...

static autoPtr< MeshedSurface >	New (const fileName &name)
	Read construct from filename (file type implicit from extension) More...

static void	write (const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
	Write to file, selecting writer based on its extension. More...

static void	write (const fileName &name, const word &fileType, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)
	Write to file, selecting writer based on the given extension. More...

Static Public Member Functions inherited from sampledSurface
static autoPtr< sampledSurface >	New (const word &name, const polyMesh &mesh, const dictionary &dict)
	Return a reference to the selected surface. More...

Static Public Attributes inherited from sampledSurface
static const wordList	surfaceFieldTypes
	Class names for surface field types. More...

Static Protected Member Functions inherited from sampledSurface
template<class Type >
static tmp< Field< Type > >	sampleOnFaces (const interpolation< Type > &sampler, const labelUList &elements, const faceList &fcs, const pointField &pts, const Type &defaultValue=Type(Zero))
	Loop for sampling volume elements to faces. More...

template<class Type >
static tmp< Field< Type > >	sampleOnPoints (const interpolation< Type > &interpolator, const labelUList &elements, const faceList &fcs, const pointField &pts)
	Loop for interpolating volume elements to face points. More...

template<class Type >
static tmp< GeometricField< Type, fvPatchField, volMesh > >	pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld)
	Create cell values by averaging the point values. More...

Detailed Description

A sampledSurface on patches. Non-triangulated by default.

This is often embedded as part of a sampled surfaces function object.

Usage

Example of function object partial specification:

surfaces
{
    surface1
    {
        type    patch;
        patches (inlet "outlet.*");
    }
}

Where the sub-entries comprise:

Property	Description	Required	Default
`type`	patch	yes
`patches`	patch selection as word/regex list	yes
`triangulate`	triangulate faces	no	false

Source files

Definition at line 95 of file sampledPatch.H.

Constructor & Destructor Documentation

◆ sampledPatch() [1/2]

sampledPatch	(	const word &	name,
		const polyMesh &	mesh,
		const UList< wordRe > &	patchNames,
		const bool	triangulate = `false`
	)

Construct from components.

Definition at line 51 of file sampledPatch.C.

◆ sampledPatch() [2/2]

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

Construct from dictionary.

Definition at line 66 of file sampledPatch.C.

◆ ~sampledPatch()

virtual ~sampledPatch ( )

virtualdefault

Destructor.

Member Function Documentation

◆ patchNames()

const wordRes& patchNames ( ) const

inlineprotected

The selection (word/regex) of patches.

Definition at line 159 of file sampledPatch.H.

Referenced by sampledPatchInternalField::print().

Here is the caller graph for this function:

◆ patchIDs()

const Foam::labelList & patchIDs ( ) const

protected

The patches selected.

Definition at line 81 of file sampledPatch.C.

References DynamicList< T, SizeMin >::append(), polyMesh::boundaryMesh(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, sampledSurface::mesh(), IOobject::name(), Foam::nl, os(), List< T >::resize(), and WarningInFunction.

Here is the call graph for this function:

◆ patchStart()

const labelList& patchStart ( ) const

inlineprotected

The offset into patchIndex, patchFaceLabels.

Definition at line 168 of file sampledPatch.H.

◆ patchIndex()

const labelList& patchIndex ( ) const

inlineprotected

For each face, the patch ID.

Definition at line 174 of file sampledPatch.H.

◆ patchFaceLabels()

const labelList& patchFaceLabels ( ) const

inlineprotected

For each face, the patch local face ID.

Definition at line 180 of file sampledPatch.H.

◆ TypeName()

TypeName ( "sampledPatch" )

Runtime type information.

◆ needsUpdate()

bool needsUpdate ( ) const

virtual

Does the surface need an update?

Implements sampledSurface.

Definition at line 146 of file sampledPatch.C.

◆ expire()

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

References clear(), and sampledSurface::clearGeom().

Here is the call graph for this function:

◆ update()

bool update ( )

virtual

Update the surface as required.

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

Implements sampledSurface.

Definition at line 174 of file sampledPatch.C.

References IndirectList< T >::addressing(), polyMesh::boundaryMesh(), Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Foam::identity(), PrimitivePatch< FaceList, PointField >::localFaces(), PrimitivePatch< FaceList, PointField >::localPoints(), mesh, points, Foam::Pout, Foam::BitOps::print(), List< T >::resize(), and polyPatch::start().

Here is the call graph for this function:

◆ points()

virtual const pointField& points ( ) const

inlinevirtual

Points of surface.

Implements sampledSurface.

Definition at line 232 of file sampledPatch.H.

References points.

Referenced by sampledPatchInternalField::print().

Here is the caller graph for this function:

◆ faces()

virtual const faceList& faces ( ) const

inlinevirtual

Faces of surface.

Implements sampledSurface.

Definition at line 238 of file sampledPatch.H.

References MeshedSurface< face >::surfFaces().

Referenced by sampledPatchInternalField::print().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zoneIds()

virtual const labelList& zoneIds ( ) const

inlinevirtual

Per-face zone/region information.

Reimplemented from meshedSurf.

Definition at line 244 of file sampledPatch.H.

References List< T >::null().

Here is the call graph for this function:

◆ Sf()

virtual const vectorField& Sf ( ) const

inlinevirtual

Face area vectors.

Implements sampledSurface.

Definition at line 250 of file sampledPatch.H.

References MeshedSurface< face >::Sf().

Here is the call graph for this function:

◆ magSf()

virtual const scalarField& magSf ( ) const

inlinevirtual

Face area magnitudes.

Implements sampledSurface.

Definition at line 256 of file sampledPatch.H.

References MeshedSurface< face >::magSf().

Here is the call graph for this function:

◆ Cf()

virtual const vectorField& Cf ( ) const

inlinevirtual

Face centres.

Implements sampledSurface.

Definition at line 262 of file sampledPatch.H.

References MeshedSurface< face >::Cf().

Here is the call graph for this function:

◆ sample() [1/10]

Foam::tmp< Foam::scalarField > sample ( const interpolation< scalar > & sampler ) const

virtual

Sample boundary of volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 277 of file sampledPatch.C.

◆ sample() [2/10]

Foam::tmp< Foam::vectorField > sample ( const interpolation< vector > & sampler ) const

virtual

Sample boundary of volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 286 of file sampledPatch.C.

◆ sample() [3/10]

Foam::tmp< Foam::sphericalTensorField > sample ( const interpolation< sphericalTensor > & sampler ) const

virtual

Sample boundary of volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 295 of file sampledPatch.C.

◆ sample() [4/10]

Foam::tmp< Foam::symmTensorField > sample ( const interpolation< symmTensor > & sampler ) const

virtual

Sample boundary of volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 304 of file sampledPatch.C.

◆ sample() [5/10]

Foam::tmp< Foam::tensorField > sample ( const interpolation< tensor > & sampler ) const

virtual

Sample boundary of volume field onto surface faces.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 313 of file sampledPatch.C.

◆ withSurfaceFields()

bool withSurfaceFields ( ) const

virtual

Can it sample surface-fields?

Reimplemented from sampledSurface.

Definition at line 321 of file sampledPatch.C.

◆ sample() [6/10]

Foam::tmp< Foam::scalarField > sample ( const surfaceScalarField & sField ) const

virtual

Sample boundary of surface field on surface.

Reimplemented from sampledSurface.

Definition at line 328 of file sampledPatch.C.

◆ sample() [7/10]

Foam::tmp< Foam::vectorField > sample ( const surfaceVectorField & sField ) const

virtual

Sample boundary of surface field on surface.

Reimplemented from sampledSurface.

Definition at line 337 of file sampledPatch.C.

◆ sample() [8/10]

Foam::tmp< Foam::sphericalTensorField > sample ( const surfaceSphericalTensorField & sField ) const

virtual

Sample boundary of surface field on surface.

Reimplemented from sampledSurface.

Definition at line 346 of file sampledPatch.C.

◆ sample() [9/10]

Foam::tmp< Foam::symmTensorField > sample ( const surfaceSymmTensorField & sField ) const

virtual

Sample boundary of surface field on surface.

Reimplemented from sampledSurface.

Definition at line 355 of file sampledPatch.C.

◆ sample() [10/10]

Foam::tmp< Foam::tensorField > sample ( const surfaceTensorField & sField ) const

virtual

Sample boundary of surface field on surface.

Reimplemented from sampledSurface.

Definition at line 364 of file sampledPatch.C.

◆ interpolate() [1/5]

Foam::tmp< Foam::scalarField > interpolate ( const interpolation< scalar > & interpolator ) const

virtual

Interpolate boundary of volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 373 of file sampledPatch.C.

◆ interpolate() [2/5]

Foam::tmp< Foam::vectorField > interpolate ( const interpolation< vector > & interpolator ) const

virtual

Interpolate boundary of volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 382 of file sampledPatch.C.

◆ interpolate() [3/5]

Foam::tmp< Foam::sphericalTensorField > interpolate ( const interpolation< sphericalTensor > & interpolator ) const

virtual

Interpolate boundary of volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 391 of file sampledPatch.C.

◆ interpolate() [4/5]

Foam::tmp< Foam::symmTensorField > interpolate ( const interpolation< symmTensor > & interpolator ) const

virtual

Interpolate boundary of volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 400 of file sampledPatch.C.

◆ interpolate() [5/5]

Foam::tmp< Foam::tensorField > interpolate ( const interpolation< tensor > & interpolator ) const

virtual

Interpolate boundary of volume field onto surface points.

Implements sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 409 of file sampledPatch.C.

◆ print()

void print	(	Ostream &	os,
		int	level = `0`
	)		const

virtual

Print information.

Reimplemented from sampledSurface.

Reimplemented in sampledPatchInternalField.

Definition at line 417 of file sampledPatch.C.

References Foam::flatOutput(), Foam::name(), os(), and points.

Here is the call graph for this function:

◆ sampleOnFaces() [1/2]

Foam::tmp<Foam::Field<Type> > sampleOnFaces ( const interpolation< Type > & sampler ) const

Definition at line 36 of file sampledPatchTemplates.C.

References forAll, Foam::New(), interpolation< Type >::psi(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ sampleOnFaces() [2/2]

Foam::tmp<Foam::Field<Type> > sampleOnFaces ( const GeometricField< Type, fvsPatchField, surfaceMesh > & sField ) const

Definition at line 61 of file sampledPatchTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), forAll, Foam::New(), and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ sampleOnPoints()

Foam::tmp<Foam::Field<Type> > sampleOnPoints ( const interpolation< Type > & interpolator ) const

Definition at line 84 of file sampledPatchTemplates.C.

References f(), forAll, interpolation< Type >::interpolate(), mesh, Foam::New(), points, bitSet::set(), polyPatch::start(), and Foam::HashTableOps::values().

Here is the call graph for this function:

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledPatch() [1/2]

◆ sampledPatch() [2/2]

◆ ~sampledPatch()

Member Function Documentation

◆ patchNames()

◆ patchIDs()

◆ patchStart()

◆ patchIndex()

◆ patchFaceLabels()

◆ TypeName()

◆ needsUpdate()

◆ expire()

◆ update()

◆ points()

◆ faces()

◆ zoneIds()

◆ Sf()

◆ magSf()

◆ Cf()

◆ sample() [1/10]

◆ sample() [2/10]

◆ sample() [3/10]

◆ sample() [4/10]

◆ sample() [5/10]

◆ withSurfaceFields()

◆ sample() [6/10]

◆ sample() [7/10]

◆ sample() [8/10]

◆ sample() [9/10]

◆ sample() [10/10]

◆ interpolate() [1/5]

◆ interpolate() [2/5]

◆ interpolate() [3/5]

◆ interpolate() [4/5]

◆ interpolate() [5/5]

◆ print()

◆ sampleOnFaces() [1/2]

◆ sampleOnFaces() [2/2]

◆ sampleOnPoints()