sampledNone Class Reference

A no operation sampledSurface that can be used when a sampler is expected but is not desired. For example, to temporarily disable a sampling definition, or to provide a boilerplate definition that is overwritten at a later stage in a dictionary. More...

Inheritance diagram for sampledNone:

Collaboration diagram for sampledNone:

Public Member Functions
	TypeName ("sampledNone")
	sampledNone ()
	sampledNone (const word &name)
	sampledNone (const word &name, const polyMesh &, const dictionary &)
virtual	~sampledNone ()=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 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
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 bool	withSurfaceFields () const
virtual tmp< scalarField >	sample (const surfaceScalarField &sField) const
virtual tmp< vectorField >	sample (const surfaceVectorField &sField) const
virtual tmp< sphericalTensorField >	sample (const surfaceSphericalTensorField &sField) const
virtual tmp< symmTensorField >	sample (const surfaceSymmTensorField &sField) const
virtual tmp< tensorField >	sample (const surfaceTensorField &sField) const
virtual void	rename (const word &newName)
virtual void	print (Ostream &os, int level=0) const
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 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)
virtual void	remapFaces (const labelUList &faceMapNewToOld)
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

A no operation sampledSurface that can be used when a sampler is expected but is not desired. For example, to temporarily disable a sampling definition, or to provide a boilerplate definition that is overwritten at a later stage in a dictionary.

Usage

Property	Description	Required	Default
type	'none'	yes

Source files

• sampledNone.H
• sampledNone.C

Definition at line 66 of file sampledNone.H.

Constructor & Destructor Documentation

sampledNone() [1/3]

sampledNone ( )

explicit

Definition at line 37 of file sampledNone.C.

sampledNone() [2/3]

sampledNone ( const word &  name )

explicit

Definition at line 43 of file sampledNone.C.

sampledNone() [3/3]

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

Definition at line 50 of file sampledNone.C.

~sampledNone()

virtual ~sampledNone ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"sampledNone"

)

needsUpdate()

bool needsUpdate ( ) const

virtual

Implements sampledSurface.

Definition at line 62 of file sampledNone.C.

expire()

bool expire ( )

virtual

Implements sampledSurface.

Definition at line 68 of file sampledNone.C.

update()

bool update ( )

virtual

Implements sampledSurface.

Definition at line 74 of file sampledNone.C.

points()

virtual const pointField& points ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 107 of file sampledNone.H.

References points.

faces()

virtual const faceList& faces ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 113 of file sampledNone.H.

References MeshedSurface::surfFaces().

Here is the call graph for this function:

zoneIds()

virtual const labelList& zoneIds ( ) const

inlinevirtual

Reimplemented from meshedSurf.

Definition at line 119 of file sampledNone.H.

References List::null().

Here is the call graph for this function:

Sf()

virtual const vectorField& Sf ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 125 of file sampledNone.H.

References MeshedSurface::Sf().

Here is the call graph for this function:

magSf()

virtual const scalarField& magSf ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 131 of file sampledNone.H.

References MeshedSurface::magSf().

Here is the call graph for this function:

Cf()

virtual const vectorField& Cf ( ) const

inlinevirtual

Implements sampledSurface.

Definition at line 137 of file sampledNone.H.

References MeshedSurface::Cf().

Here is the call graph for this function:

sample() [1/5]

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

virtual

Implements sampledSurface.

Definition at line 88 of file sampledNone.C.

sample() [2/5]

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

virtual

Implements sampledSurface.

Definition at line 89 of file sampledNone.C.

sample() [3/5]

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

virtual

Implements sampledSurface.

Definition at line 90 of file sampledNone.C.

sample() [4/5]

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

virtual

Implements sampledSurface.

Definition at line 91 of file sampledNone.C.

sample() [5/5]

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

virtual

Implements sampledSurface.

Definition at line 92 of file sampledNone.C.

interpolate() [1/5]

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

virtual

Implements sampledSurface.

Definition at line 94 of file sampledNone.C.

interpolate() [2/5]

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

virtual

Implements sampledSurface.

Definition at line 95 of file sampledNone.C.

interpolate() [3/5]

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

virtual

Implements sampledSurface.

Definition at line 96 of file sampledNone.C.

interpolate() [4/5]

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

virtual

Implements sampledSurface.

Definition at line 97 of file sampledNone.C.

interpolate() [5/5]

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

virtual

Implements sampledSurface.

Definition at line 98 of file sampledNone.C.

---

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

• src/sampling/sampledSurface/sampledNone/sampledNone.H
• src/sampling/sampledSurface/sampledNone/sampledNone.C