Set of surfaces to sample. More...

Inheritance diagram for sampledSurfaces:

Collaboration diagram for sampledSurfaces:

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

	sampledSurfaces (const word &name, const Time &time, const dictionary &dict)
	Construct from Time and dictionary. More...

	sampledSurfaces (const sampledSurfaces &)=delete
	Disallow default bitwise copy construction. More...

virtual	~sampledSurfaces ()
	Destructor. More...

virtual bool	needsUpdate () const
	Does any of the surfaces need an update? More...

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

virtual bool	update ()
	Update the surfaces as required and merge surface points (parallel). More...

void	verbose (const bool verbosity=true)
	Set verbosity level. More...

virtual bool	read (const dictionary &)
	Read the sampledSurfaces dictionary. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Execute, currently does nothing. More...

virtual bool	write ()
	Sample and write. More...

virtual void	movePoints (const polyMesh &)
	Update for mesh point-motion - expires the surfaces. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map - expires the surfaces. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	readUpdate (const polyMesh::readUpdateState state)
	Update topology using the given map due to readUpdate. More...

void	operator= (const sampledSurfaces &)=delete
	Disallow default bitwise assignment. More...

template<class Type >
Foam::PtrList< Foam::Field< Type > >	sampleLocalType (const label surfi, const wordList &fieldNames, HashPtrTable< interpolation< Type >> &interpolations)

template<class Type >
Foam::PtrList< Foam::Field< Type > >	sampleType (const label surfi, const wordList &fieldNames, HashPtrTable< interpolation< Type >> &interpolations)

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

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. More...

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

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("functionObject")

virtual const word &	type () const =0
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name)
	Construct from components. More...

autoPtr< functionObject >	clone () const
	Return clone. More...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from PtrList< sampledSurface >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< sampledSurface > &)
	Copy constructor. More...

	PtrList (const PtrList< sampledSurface > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (PtrList< sampledSurface > &&)
	Move constructor. More...

	PtrList (PtrList< sampledSurface > &, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< sampledSurface > &)
	Construct as copy of SLPtrList<T> More...

	PtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. More...

void	setSize (const label)
	Reset size of PtrList. If extending the PtrList, new entries are. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

void	append (sampledSurface *)
	Append an element at the end of the list. More...

void	append (const autoPtr< sampledSurface > &)

void	append (const tmp< sampledSurface > &)

void	transfer (PtrList< sampledSurface > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

bool	set (const label) const
	Is element set. More...

autoPtr< sampledSurface >	set (const label, sampledSurface *)
	Set element to given T* and return old element (can be nullptr) More...

autoPtr< sampledSurface >	set (const label, const autoPtr< sampledSurface > &)
	Set element to given autoPtr<T> and return old element. More...

autoPtr< sampledSurface >	set (const label, const tmp< sampledSurface > &)
	Set element to given tmp<T> and return old element. More...

void	reorder (const labelUList &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

void	shuffle (const labelUList &newToOld)
	Reorders elements. Ordering does not have to be done in. More...

void	operator= (const PtrList< sampledSurface > &)
	Assignment operator. More...

void	operator= (PtrList< sampledSurface > &&)
	Move assignment operator. More...

Public Member Functions inherited from UPtrList< T >
	UPtrList ()
	Null Constructor. More...

	UPtrList (const label)
	Construct with size specified. More...

	UPtrList (UPtrList< T > &, bool reuse)
	Construct as copy or re-use as specified. More...

label	size () const
	Return the number of elements in the UPtrList. More...

bool	empty () const
	Return true if the UPtrList is empty (ie, size() is zero) More...

T &	first ()
	Return reference to the first element of the list. More...

const T &	first () const
	Return reference to first element of the list. More...

T &	last ()
	Return reference to the last element of the list. More...

const T &	last () const
	Return reference to the last element of the list. More...

void	setSize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	resize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	clear ()
	Clear the UPtrList, i.e. set size to zero. More...

void	transfer (UPtrList< T > &)
	Transfer the contents of the argument UPtrList into this. More...

bool	set (const label) const
	Is element set. More...

T *	set (const label, T *)
	Set element. Return old element (can be nullptr). More...

void	reorder (const labelUList &oldToNew)
	Reorders elements. Ordering does not have to be done in. More...

void	shuffle (const labelUList &newToOld)
	Reorders elements. Ordering does not have to be done in. More...

template<class T2 >
UPtrList< T2 >	convert ()
	Convert to list of different pointer type. More...

template<class T2 >
UPtrList< const T2 >	convert () const
	Convert to list of different pointer type. More...

const T &	operator[] (const label) const
	Return element const reference. More...

T &	operator[] (const label)
	Return element reference. More...

const T *	operator() (const label) const
	Return element const pointer. More...

iterator	begin ()
	Return an iterator to begin traversing the UPtrList. More...

iterator	end ()
	Return an iterator to end traversing the UPtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the UPtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the UPtrList. More...

template<class T2 >
Foam::UPtrList< T2 >	convert ()

template<class T2 >
Foam::UPtrList< const T2 >	convert () const

Additional Inherited Members
Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the UPtrList contains. More...

typedef T &	reference
	Type that can be used for storing into UPtrList::value_type objects. More...

typedef const T &	const_reference
	Type that can be used for storing into constant UPtrList::value_type. More...

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Member Functions inherited from PtrList< sampledSurface >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Detailed Description

Set of surfaces to sample.

Example of function object specification:

surfaces1
{
    type            surfaces;
    libs            ("libsampling.so");

    writeControl    writeTime;

    fields          (p U);

    surfaceFormat   vtk;
    interpolationScheme cellPoint;

    surfaces
    (
        p1e5
        {
            type            isoSurface;
            isoField        p;
            isoValue        1e5;
            interpolate     yes;
        }
    );
}

Usage

Property	Description	Required	Default value
`type`	type name: surfaces	yes
`surfaceFormat`	the format in which to write the surface file	yes
`interpolationScheme`	the method by which values are interpolated from the mesh to the surface	yes
`writeEmpty`	write out files for empty surfaces	no	no
`surfaces`	the list of surfaces	yes

See also: Foam::sampledSurfaces

Source files

Definition at line 130 of file sampledSurfaces.H.

Constructor & Destructor Documentation

◆ sampledSurfaces() [1/2]

sampledSurfaces	(	const word &	name,
		const Time &	time,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 57 of file sampledSurfaces.C.

References polyMesh::defaultRegion, Foam::name(), writeFile::outputPrefix, and Foam::read().

Here is the call graph for this function:

◆ sampledSurfaces() [2/2]

sampledSurfaces ( const sampledSurfaces & )

delete

Disallow default bitwise copy construction.

◆ ~sampledSurfaces()

~sampledSurfaces ( )

virtual

Destructor.

Definition at line 86 of file sampledSurfaces.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaces" )

Runtime type information.

◆ needsUpdate()

bool needsUpdate ( ) const

virtual

Does any of the surfaces need an update?

Definition at line 325 of file sampledSurfaces.C.

References forAll.

◆ expire()

bool expire ( )

virtual

Mark the surfaces as needing an update.

May also free up unneeded data. Return false if all surfaces were already marked as expired.

Definition at line 339 of file sampledSurfaces.C.

References forAll, and UPstream::parRun().

Here is the call graph for this function:

◆ update()

bool update ( )

virtual

Update the surfaces as required and merge surface points (parallel).

Return false if no surfaces required an update.

Definition at line 362 of file sampledSurfaces.C.

References Foam::endl(), sampledSurface::faces(), forAll, PatchTools::gatherAndMerge(), UPstream::master(), Foam::nl, UPstream::parRun(), points, sampledSurface::points(), Foam::Pout, s(), List< T >::size(), and sampledSurface::update().

Here is the call graph for this function:

◆ verbose()

void verbose ( const bool verbosity = true )

Set verbosity level.

Definition at line 92 of file sampledSurfaces.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the sampledSurfaces dictionary.

Reimplemented from regionFunctionObject.

Definition at line 209 of file sampledSurfaces.C.

References Foam::endl(), forAll, dictionary::found(), Foam::Info, dictionary::lookup(), UPstream::master(), surfaceWriter::New(), Foam::nl, UPstream::parRun(), Foam::Pout, and dictionary::readIfPresent().

Here is the call graph for this function:

◆ fields()

Foam::wordList fields ( ) const

virtual

Return the list of fields required.

Implements functionObject.

Definition at line 268 of file sampledSurfaces.C.

References List< T >::append(), fields, and forAll.

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 98 of file sampledSurfaces.C.

◆ write()

bool write ( )

virtual

Sample and write.

Implements functionObject.

Definition at line 104 of file sampledSurfaces.C.

References DeclareInterpolations, Foam::endl(), sampledSurface::faces(), fieldNames, FieldTypeValuesParameter, Foam::FOR_ALL_FIELD_TYPES(), forAll, FoundFieldType, GenerateFieldTypeValues, sampledSurface::interpolate(), UPstream::master(), Foam::mkDir(), sampledSurface::name(), Foam::nl, UPstream::parRun(), sampledSurface::points(), Foam::Pout, s(), and List< T >::size().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for mesh point-motion - expires the surfaces.

Reimplemented from functionObject.

Definition at line 281 of file sampledSurfaces.C.

References sampledSurfaces::topoChange().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map - expires the surfaces.

Reimplemented from functionObject.

Definition at line 291 of file sampledSurfaces.C.

References sampledSurfaces::mapMesh(), and polyTopoChangeMap::mesh().

Referenced by sampledSurfaces::movePoints().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 305 of file sampledSurfaces.C.

References sampledSurfaces::readUpdate().

Referenced by sampledSurfaces::topoChange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readUpdate()

void readUpdate ( const polyMesh::readUpdateState state )

virtual

Update topology using the given map due to readUpdate.

expires the surfaces

Definition at line 314 of file sampledSurfaces.C.

References polyMesh::UNCHANGED.

Referenced by sampledSurfaces::mapMesh().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const sampledSurfaces & )

delete

Disallow default bitwise assignment.

◆ sampleLocalType()

Foam::PtrList<Foam::Field<Type> > sampleLocalType	(	const label	surfi,
		const wordList &	fieldNames,
		HashPtrTable< interpolation< Type >> &	interpolations
	)

Definition at line 37 of file sampledSurfacesTemplates.C.

References forAll, Foam::name(), s(), sf(), and List< T >::size().

Here is the call graph for this function:

◆ sampleType()

Foam::PtrList<Foam::Field<Type> > sampleType	(	const label	surfi,
		const wordList &	fieldNames,
		HashPtrTable< interpolation< Type >> &	interpolations
	)

Definition at line 98 of file sampledSurfacesTemplates.C.

References PtrList< T >::clear(), Foam::combine(), f(), fieldNames, forAll, Foam::inplaceReorder(), points, PtrList< T >::resize(), PtrList< T >::set(), List< Type >::setSize(), and UPtrList< T >::size().

Here is the call graph for this function:

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

src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.H
src/sampling/sampledSurface/sampledSurfaces/sampledSurfaces.C
src/sampling/sampledSurface/sampledSurfaces/sampledSurfacesTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledSurfaces() [1/2]

◆ sampledSurfaces() [2/2]

◆ ~sampledSurfaces()

Member Function Documentation

◆ TypeName()

◆ needsUpdate()

◆ expire()

◆ update()

◆ verbose()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ readUpdate()

◆ operator=()

◆ sampleLocalType()

◆ sampleType()