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")
	Runtime type information. More...

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

virtual	~sampledPatchInternalField ()
	Destructor. More...

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

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

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

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

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

virtual tmp< scalarField >	interpolate (const interpolation< scalar > &) const
	Interpolate field on surface. More...

virtual tmp< vectorField >	interpolate (const interpolation< vector > &) const
	Interpolate field on surface. More...

virtual tmp< sphericalTensorField >	interpolate (const interpolation< sphericalTensor > &) const
	Interpolate field on surface. More...

virtual tmp< symmTensorField >	interpolate (const interpolation< symmTensor > &) const
	Interpolate field on surface. More...

virtual tmp< tensorField >	interpolate (const interpolation< tensor > &) const
	Interpolate field on surface. More...

virtual void	print (Ostream &) const
	Write. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleField (const GeometricField< Type, fvPatchField, volMesh > &vField) const

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

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

	sampledPatch (const word &name, const polyMesh &mesh, const wordReList &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 ()
	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...

template<class Type >
Foam::tmp< Foam::Field< Type > >	sampleField (const GeometricField< Type, fvPatchField, volMesh > &vField) const

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

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

Public Member Functions inherited from MeshedSurface< face >
	MeshedSurface ()
	Construct null. More...

	MeshedSurface (const Xfer< pointField > &, const Xfer< List< Face > > &, const Xfer< surfZoneList > &)
	Construct by transferring components (points, faces, zones). More...

	MeshedSurface (const Xfer< pointField > &, const Xfer< List< Face > > &, const labelUList &zoneSizes=labelUList(), const UList< word > &zoneNames=UList< word >())
	Construct by transferring components (points, faces). More...

	MeshedSurface (const MeshedSurface &)
	Construct as copy. More...

	MeshedSurface (const UnsortedMeshedSurface< Face > &)
	Construct from a UnsortedMeshedSurface. More...

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

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

	MeshedSurface (const Xfer< UnsortedMeshedSurface< Face > > &)
	Construct by transferring the contents from a UnsortedMeshedSurface. More...

	MeshedSurface (const Xfer< MeshedSurface< Face > > &)
	Construct by transferring the contents from a MeshedSurface. More...

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

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

	MeshedSurface (const Time &, const word &surfName="")
	Construct from database. More...

	MeshedSurface ()

	MeshedSurface (const Xfer< pointField > &pointLst, const Xfer< List< Face > > &faceLst, const Xfer< surfZoneList > &zoneLst)

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

	MeshedSurface (const MeshedSurface< Face > &surf)

	MeshedSurface (const UnsortedMeshedSurface< Face > &surf)

	MeshedSurface (const surfMesh &mesh)

	MeshedSurface (const polyBoundaryMesh &bMesh, const bool useGlobalPoints)

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

	MeshedSurface (const fileName &name)

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

	MeshedSurface (const Xfer< UnsortedMeshedSurface< Face > > &surf)

	MeshedSurface (const Xfer< MeshedSurface< Face > > &surf)

	ClassName ("MeshedSurface")
	Runtime type information. More...

bool	isTri ()
	Specialization for holding triangulated information. 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),(name, surf))

virtual void	write (const fileName &name) const
	Generic write routine. Chooses writer based on extension. More...

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

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

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

const List< surfZone > &	surfZones () const
	Const access to the surface zones. 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...

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

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

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

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

virtual void	reset (const Xfer< pointField > &points, const Xfer< List< Face > > &faces, const Xfer< surfZoneList > &zones)
	Reset primitive data (points, faces and zones) More...

virtual void	reset (const Xfer< List< point > > &points, const Xfer< List< Face > > &faces, const Xfer< surfZoneList > &zones)
	Reset primitive data (points, faces and zones) More...

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

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

virtual bool	checkFaces (const bool verbose=false)

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

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

label	triangulate ()
	Specialization for holding triangulated information. More...

label	triangulate (List< label > &faceMap)
	Specialization for holding triangulated information. More...

MeshedSurface	subsetMesh (const labelHashSet &include, labelList &pointMap, labelList &faceMap) const
	Return new surface. More...

MeshedSurface	subsetMesh (const labelHashSet &include) const
	Return new surface. More...

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

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

Xfer< MeshedSurface< Face > >	xfer ()
	Transfer contents to the Xfer container. More...

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

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

void	writeStats (Ostream &os) const

void	operator= (const MeshedSurface< Face > &)

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

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 &, const bool interpolate=false)
	Construct from name, mesh. More...

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

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

virtual	~sampledSurface ()
	Destructor. More...

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

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

bool	interpolate () const
	Interpolation requested for surface. More...

virtual const vectorField &	Sf () const
	Return face area vectors. More...

virtual const scalarField &	magSf () const
	Return face area magnitudes. More...

virtual const vectorField &	Cf () const
	Return face centres as vectorField. More...

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

template<class Type >
Type	integrate (const Field< Type > &) const
	Integration of a field across the surface. More...

template<class Type >
Type	integrate (const tmp< Field< Type > > &) const
	Integration of a field across the surface. More...

template<class Type >
Type	average (const Field< Type > &) const
	Area-averaged value of a field across the surface. More...

template<class Type >
Type	average (const tmp< Field< Type > > &) const
	Area-averaged value of a field across the surface. More...

tmp< Field< scalar > >	project (const Field< scalar > &) const
	Project field onto surface. More...

tmp< Field< scalar > >	project (const Field< vector > &) const
	Project field onto surface. More...

tmp< Field< vector > >	project (const Field< sphericalTensor > &) const
	Project field onto surface. More...

tmp< Field< vector > >	project (const Field< symmTensor > &) const
	Project field onto surface. More...

tmp< Field< vector > >	project (const Field< tensor > &) const
	Project field onto surface. More...

template<class Type >
tmp< GeometricField< Type, fvPatchField, volMesh > >	pointAverage (const GeometricField< Type, pointPatchField, pointMesh > &pfld) const
	Interpolate from points to cell centre. More...

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

template<class ReturnType , class Type >
Foam::tmp< Foam::Field< ReturnType > >	project (const tmp< Field< Type > > &field) const

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

Private Member Functions
template<class Type >
tmp< Field< Type > >	sampleField (const GeometricField< Type, fvPatchField, volMesh > &vField) const
	Sample field on faces. More...

template<class Type >
tmp< Field< Type > >	interpolateField (const interpolation< Type > &) const

Private Attributes
PtrList< mappedPatchBase >	mappers_
	Mapping engines. More...

Additional Inherited Members
Public Types inherited from MeshedSurface< face >
typedef Face	FaceType
	Face type used. More...

Static Public Member Functions inherited from MeshedSurface< face >
static bool	isTri ()
	Face storage only handles triangulated faces. More...

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

static bool	canReadType (const word &ext, const bool verbose=false)
	Can we read this file format? More...

static bool	canWriteType (const word &ext, const bool verbose=false)
	Can we write this file format? More...

static wordHashSet	readTypes ()

static wordHashSet	writeTypes ()

static autoPtr< MeshedSurface >	New (const fileName &, const word &ext)
	Select constructed from filename (explicit extension) More...

static autoPtr< MeshedSurface >	New (const fileName &)
	Select constructed from filename (implicit extension) More...

static void	write (const fileName &, const MeshedSurface< Face > &)
	Write to file. More...

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

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

const labelList &	patchIDs () const

const labelList &	patchStart () const

const labelList &	patchFaceLabels () const

Protected Member Functions inherited from MeshedSurface< face >
void	transcribe (MeshedSurface< face > &)
	Transfer points/zones and transcribe face -> triFace. More...

void	transcribe (MeshedSurface< face > &surf)

void	transcribe (MeshedSurface< face > &surf)

void	checkZones ()
	Basic sanity check on zones. More...

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

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

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

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

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

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.

Source files

Definition at line 54 of file sampledPatchInternalField.H.

Constructor & Destructor Documentation

◆ sampledPatchInternalField()

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

Construct from dictionary.

Definition at line 52 of file sampledPatchInternalField.C.

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

Here is the call graph for this function:

◆ ~sampledPatchInternalField()

~sampledPatchInternalField ( )

virtual

Destructor.

Definition at line 140 of file sampledPatchInternalField.C.

Member Function Documentation

◆ sampleField() [1/2]

tmp<Field<Type> > sampleField ( const GeometricField< Type, fvPatchField, volMesh > & vField ) const

private

Sample field on faces.

◆ interpolateField() [1/2]

tmp<Field<Type> > interpolateField ( const interpolation< Type > & ) const

private

◆ TypeName()

TypeName ( "sampledPatchInternalField" )

Runtime type information.

◆ sample() [1/5]

Foam::tmp< Foam::scalarField > sample ( const volScalarField & vField ) const

virtual

Sample field on surface.

Reimplemented from sampledPatch.

Definition at line 147 of file sampledPatchInternalField.C.

◆ sample() [2/5]

Foam::tmp< Foam::tensorField > sample ( const volVectorField & vField ) const

virtual

Sample field on surface.

Reimplemented from sampledPatch.

Definition at line 156 of file sampledPatchInternalField.C.

◆ sample() [3/5]

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

virtual

Sample field on surface.

Reimplemented from sampledPatch.

◆ sample() [4/5]

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

virtual

Sample field on surface.

Reimplemented from sampledPatch.

◆ sample() [5/5]

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

virtual

Sample field on surface.

Reimplemented from sampledPatch.

◆ interpolate() [1/5]

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

virtual

Interpolate field on surface.

Reimplemented from sampledPatch.

Definition at line 191 of file sampledPatchInternalField.C.

◆ interpolate() [2/5]

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

virtual

Interpolate field on surface.

Reimplemented from sampledPatch.

Definition at line 200 of file sampledPatchInternalField.C.

◆ interpolate() [3/5]

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

virtual

Interpolate field on surface.

Reimplemented from sampledPatch.

Definition at line 210 of file sampledPatchInternalField.C.

◆ interpolate() [4/5]

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

virtual

Interpolate field on surface.

Reimplemented from sampledPatch.

Definition at line 219 of file sampledPatchInternalField.C.

◆ interpolate() [5/5]

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

virtual

Interpolate field on surface.

Reimplemented from sampledPatch.

Definition at line 228 of file sampledPatchInternalField.C.

◆ print()

void print ( Ostream & os ) const

virtual

Write.

Reimplemented from sampledPatch.

Definition at line 236 of file sampledPatchInternalField.C.

References Foam::name(), patchNames(), points, and List::size().

Here is the call graph for this function:

◆ sampleField() [2/2]

Foam::tmp<Foam::Field<Type> > sampleField ( const GeometricField< Type, fvPatchField, volMesh > & vField ) const

Definition at line 35 of file sampledPatchInternalFieldTemplates.C.

References forAll, GeometricField::internalField(), and Field::map().

Here is the call graph for this function:

◆ interpolateField() [2/2]

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

Definition at line 70 of file sampledPatchInternalFieldTemplates.C.

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

Here is the call graph for this function:

Field Documentation

◆ mappers_

PtrList<mappedPatchBase> mappers_

private

Mapping engines.

Definition at line 61 of file sampledPatchInternalField.H.

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

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledPatchInternalField()

◆ ~sampledPatchInternalField()

Member Function Documentation

◆ sampleField() [1/2]

◆ interpolateField() [1/2]

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

◆ sampleField() [2/2]

◆ interpolateField() [2/2]

Field Documentation

◆ mappers_