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 word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry 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 bool	execute ()
	Execute, currently does nothing. More...

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

virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh - expires the surfaces. More...

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

virtual void	readUpdate (const polyMesh::readUpdateState state)
	Update for changes of mesh due to readUpdate - expires the surfaces. More...

void	operator= (const sampledSurfaces &)=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...

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

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 PtrList< sampledSurface >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. 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
`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
`surfaces`	the list of surfaces	yes