Variation of sampledPatch that samples the internalField (at a given normal distance from the patch) instead of the patchField. Note: More...

Inheritance diagram for sampledPatchInternalField:

[legend]

Collaboration diagram for sampledPatchInternalField:

[legend]

Public Member Functions
	TypeName ("sampledPatchInternalField")

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

virtual	~sampledPatchInternalField ()=default

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

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions inherited from sampledPatch
	TypeName ("sampledPatch")

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

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

virtual	~sampledPatch ()=default

virtual bool	needsUpdate () const

virtual bool	expire ()

virtual bool	update ()

virtual const pointField &	points () const

virtual const faceList &	faces () const

virtual const labelList &	zoneIds () const

virtual const vectorField &	Sf () const

virtual const scalarField &	magSf () const

virtual const vectorField &	Cf () const

virtual bool	withSurfaceFields () const

virtual tmp< scalarField >	sample (const surfaceScalarField &) const

virtual tmp< vectorField >	sample (const surfaceVectorField &) const

virtual tmp< sphericalTensorField >	sample (const surfaceSphericalTensorField &) const

virtual tmp< symmTensorField >	sample (const surfaceSymmTensorField &) const

virtual tmp< tensorField >	sample (const surfaceTensorField &) const

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
	ClassName ("MeshedSurface")

	MeshedSurface ()

	MeshedSurface (const MeshedSurface &surf)

	MeshedSurface (const UnsortedMeshedSurface< Face > &surf)

	MeshedSurface (MeshedSurface &&surf)

	MeshedSurface (UnsortedMeshedSurface< Face > &&surf)

	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst)

	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst)

	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())

	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())

	MeshedSurface (const polyBoundaryMesh &bMesh, const bool globalPoints=false)

	MeshedSurface (const surfMesh &mesh)

	MeshedSurface (const fileName &name)

	MeshedSurface (const fileName &name, const word &fileType)

	MeshedSurface (Istream &is)

	MeshedSurface (const Time &runTime)

	MeshedSurface (const Time &runTime, const word &surfName)

	MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal=true)

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

virtual	~MeshedSurface ()

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

label	size () const

const List< Face > &	surfFaces () const

const labelList &	faceIds () const

const surfZoneList &	surfZones () const

const vectorField &	Sf () const

const scalarField &	magSf () const

const vectorField &	Cf () const

virtual void	clear ()

virtual void	addZones (const UList< surfZone > &, const bool cullEmpty=false)

virtual void	addZones (const labelUList &sizes, const UList< word > &names, const bool cullEmpty=false)

virtual void	addZones (const labelUList &sizes, const bool cullEmpty=false)

bool	addZonesToFaces ()

virtual void	removeZones ()

virtual void	movePoints (const pointField &newPoints)

virtual void	scalePoints (const scalar scaleFactor)

virtual void	cleanup (const bool verbose)

virtual void	compactPoints (labelList &pointMap=const_cast< labelList & >(labelList::null()))

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

virtual bool	checkFaces (const bool verbose=false)

virtual label	nTriangles () const

virtual label	nTriangles (labelList &faceMap) const

virtual label	triangulate ()

virtual label	triangulate (labelList &faceMap)

template<class BoolListType >
void	subsetMeshMap (const BoolListType &include, labelList &pointMap, labelList &faceMap) const

MeshedSurface	subsetMesh (const UList< bool > &include, labelList &pointMap, labelList &faceMap) const

MeshedSurface	subsetMesh (const bitSet &include, labelList &pointMap, labelList &faceMap) const

MeshedSurface	subsetMesh (const UList< bool > &include) const

MeshedSurface	subsetMesh (const bitSet &include) const

MeshedSurface	subsetMesh (const wordRes &includeNames, const wordRes &excludeNames=wordRes()) const

void	swap (MeshedSurface< Face > &surf)

void	transfer (pointField &pointLst, List< Face > &faceLst)

void	transfer (MeshedSurface< Face > &surf)

void	transfer (UnsortedMeshedSurface< Face > &surf)

autoPtr< MeshedSurface< Face > >	releaseGeom ()

void	swapFaces (List< Face > &faces)

void	swapPoints (pointField &points)

bool	read (const fileName &name, const word &fileType)

virtual bool	read (const fileName &name)

void	writeStats (Ostream &os) const

virtual void	write (const fileName &name, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const

virtual void	write (const fileName &name, const word &fileType, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null) const

void	write (const Time &runTime, const word &surfName=word::null) const

void	operator= (const MeshedSurface< Face > &surf)

void	operator= (MeshedSurface< Face > &&surf)

	operator MeshedSurfaceProxy< Face > () const

template<class Face >
	MeshedSurface ()

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

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

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

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

template<class Face >
	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const UList< surfZone > &zoneLst)

template<class Face >
	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const UList< surfZone > &zoneLst)

template<class Face >
	MeshedSurface (const pointField &pointLst, const UList< Face > &faceLst, const labelUList &zoneSizes, const UList< word > &zoneNames)

template<class Face >
	MeshedSurface (pointField &&pointLst, List< Face > &&faceLst, const labelUList &zoneSizes, const UList< word > &zoneNames)

template<class Face >
	MeshedSurface (const surfMesh &mesh)

template<class Face >
	MeshedSurface (const polyBoundaryMesh &bMesh, const bool useGlobalPoints)

template<class Face >
	MeshedSurface (const fileName &name, const word &fileType)

template<class Face >
	MeshedSurface (const fileName &name)

template<class Face >
	MeshedSurface (Istream &is)

template<class Face >
	MeshedSurface (const Time &runTime)

template<class Face >
	MeshedSurface (const Time &runTime, const word &surfName)

template<class Face >
	MeshedSurface (const IOobject &io, const dictionary &dict, const bool isGlobal)

bool	addZonesToFaces ()

bool	addZonesToFaces ()

Public Member Functions inherited from sampledSurface
	TypeName ("sampledSurface")

	declareRunTimeSelectionTable (autoPtr, sampledSurface, word,(const word &name, const polyMesh &mesh, const dictionary &dict),(name, mesh, dict))

	sampledSurface (const word &name, const polyMesh &mesh, const bool interpolateToPoints=false)

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

autoPtr< sampledSurface >	clone () const

virtual	~sampledSurface ()

const polyMesh &	mesh () const noexcept

const word &	name () const noexcept

bool	enabled () const noexcept

bool	invariant () const noexcept

bool	isPointData () const noexcept

virtual bool	isPointData (const bool on)

scalar	area () const

virtual bool	hasFaceIds () const

polySurface *	getRegistrySurface (const objectRegistry &obr, word lookupName="") const

polySurface *	storeRegistrySurface (objectRegistry &obr, word lookupName="") const

bool	removeRegistrySurface (objectRegistry &obr, word lookupName="") const

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const

template<class Type , class GeoMeshType >
bool	storeRegistryField (const objectRegistry &obr, const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const

surfMesh *	getSurfMesh (word lookupName="") const

surfMesh *	storeSurfMesh (word lookupName="") const

bool	removeSurfMesh (word lookupName="") const

template<class Type , class GeoMeshType >
bool	storeSurfMeshField (const word &fieldName, const dimensionSet &dims, const Field< Type > &values, word lookupName="") const

template<class Type , class GeoMeshType >
bool	storeSurfMeshField (const word &fieldName, const dimensionSet &dims, Field< Type > &&values, word lookupName="") const

virtual void	rename (const word &newName)

bool	interpolate () const noexcept

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

virtual	~meshedSurf ()=default

virtual const labelList &	faceIds () const

Additional Inherited Members
Public Types inherited from MeshedSurface
typedef Face	face_type

typedef point	point_type

Static Public Member Functions inherited from MeshedSurface
static wordHashSet	readTypes ()

static wordHashSet	writeTypes ()

static bool	canReadType (const word &fileType, bool verbose=false)

static bool	canWriteType (const word &fileType, bool verbose=false)

static bool	canRead (const fileName &name, bool verbose=false)

static autoPtr< MeshedSurface >	New (const fileName &name, const word &fileType, bool mandatory=true)

static autoPtr< MeshedSurface >	New (const fileName &name)

static void	write (const fileName &name, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)

static void	write (const fileName &name, const word &fileType, const MeshedSurface< Face > &surf, IOstreamOption streamOpt=IOstreamOption(), const dictionary &options=dictionary::null)

Static Public Member Functions inherited from sampledSurface
static autoPtr< sampledSurface >	New (const word &name, const polyMesh &mesh, const dictionary &dict)

Static Public Attributes inherited from sampledSurface
static const wordList	surfaceFieldTypes

Protected Member Functions inherited from sampledPatch
const wordRes &	patchNames () const

const labelList &	patchIDs () const

const labelList &	patchStart () const

const labelList &	patchIndex () const

const labelList &	patchFaceLabels () const

Protected Member Functions inherited from MeshedSurface
void	transcribe (MeshedSurface< face > &surf)

void	checkZones (const bool verbose=true)

pointField &	storedPoints ()

List< Face > &	storedFaces ()

labelList &	storedFaceIds ()

surfZoneList &	storedZones ()

void	sortFacesAndStore (DynamicList< Face > &unsortedFaces, DynamicList< label > &zoneIds, DynamicList< label > &elemIds, bool sorted)

void	transcribe (MeshedSurface< face > &surf)

void	transcribe (MeshedSurface< face > &surf)

void	transcribe (MeshedSurface< face > &surf)

Protected Member Functions inherited from sampledSurface
virtual void	clearGeom () const

	sampledSurface (const word &name, std::nullptr_t)

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))

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

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

Detailed Description

Variation of sampledPatch that samples the internalField (at a given normal distance from the patch) instead of the patchField. Note:

interpolate=false : get cell value on faces
interpolate=true : interpolate inside cell and interpolate to points There is no option to get interpolated value inside the cell on the faces.

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

Usage

Example of function object partial specification:

surfaces
{
    surface1
    {
        type    patchInternalField;
        patches (inlet "outlet.*");
        offsetMode  normal;
        distance    0.05;
    }
}

Where the sub-entries comprise:

Property	Description	Required	Default
`type`	patchInternalField	yes
`patches`	patch selection as word/regex list	yes
`offsetMode`	normal/uniform/nonuniform	no	normal
`distance`	distance for normal offset	partly
`offset`	point offset for uniform offset	partly
`offsets`	point offsets for nonuniform offset	partly

Source files

Definition at line 116 of file sampledPatchInternalField.H.

Constructor & Destructor Documentation

◆ sampledPatchInternalField()

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

Definition at line 48 of file sampledPatchInternalField.C.

References dict, Foam::distance(), forAll, mesh, and Foam::mode().

Here is the call graph for this function:

◆ ~sampledPatchInternalField()

virtual ~sampledPatchInternalField ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "sampledPatchInternalField" )

◆ sample() [1/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 134 of file sampledPatchInternalField.C.

◆ sample() [2/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 143 of file sampledPatchInternalField.C.

◆ sample() [3/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 152 of file sampledPatchInternalField.C.

◆ sample() [4/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 161 of file sampledPatchInternalField.C.

◆ sample() [5/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 170 of file sampledPatchInternalField.C.

◆ interpolate() [1/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 179 of file sampledPatchInternalField.C.

◆ interpolate() [2/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 188 of file sampledPatchInternalField.C.

◆ interpolate() [3/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 198 of file sampledPatchInternalField.C.

◆ interpolate() [4/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 207 of file sampledPatchInternalField.C.

◆ interpolate() [5/5]

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

virtual

Reimplemented from sampledPatch.

Definition at line 216 of file sampledPatchInternalField.C.

◆ print()

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

virtual

Reimplemented from sampledPatch.

Definition at line 224 of file sampledPatchInternalField.C.

References sampledPatch::faces(), sampledSurface::name(), os(), sampledPatch::patchNames(), and sampledPatch::points().

Here is the call graph for this function:

◆ sampleOnFaces()

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

Definition at line 31 of file sampledPatchInternalFieldTemplates.C.

References stdFoam::end(), forAll, Field::map(), Foam::New(), interpolation::psi(), 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 68 of file sampledPatchInternalFieldTemplates.C.

References mapDistribute::distribute(), PrimitivePatchInterpolation< Patch >::faceToPointInterpolate(), forAll, interpolation::interpolate(), Foam::max(), mesh, patchId(), points, mapDistribute::reverseDistribute(), samples(), and polyPatch::start().

Here is the call graph for this function:

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

src/sampling/sampledSurface/sampledPatchInternalField/sampledPatchInternalField.H
src/sampling/sampledSurface/sampledPatchInternalField/sampledPatchInternalField.C
src/sampling/sampledSurface/sampledPatchInternalField/sampledPatchInternalFieldTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledPatchInternalField()

◆ ~sampledPatchInternalField()

Member Function Documentation

◆ TypeName()

◆ sample() [1/5]

◆ sample() [2/5]

◆ sample() [3/5]

◆ sample() [4/5]

◆ sample() [5/5]

◆ interpolate() [1/5]

◆ interpolate() [2/5]

◆ interpolate() [3/5]

◆ interpolate() [4/5]

◆ interpolate() [5/5]

◆ print()

◆ sampleOnFaces()

◆ sampleOnPoints()