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 &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	sampledSurfaces (const word &name, const objectRegistry &obr, const dictionary &dict, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary. More...

virtual	~sampledSurfaces ()=default
	Destructor. More...

bool	verbose (const bool on)
	Enable/disable verbose output. More...

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

virtual bool	execute ()
	Sample and store if the sampleOnExecute is enabled. More...

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

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

virtual void	movePoints (const polyMesh &mesh)
	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...

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

virtual	~fvMeshFunctionObject ()=default
	Destructor. 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...

virtual	~regionFunctionObject ()=default
	Destructor. More...

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

virtual	~stateFunctionObject ()=default
	Destructor. More...

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri, bool increaseOnly=true)
	Set the trigger index. Normally only if greater than current. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

virtual	~timeFunctionObject ()=default
	Destructor. More...

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))

	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components. More...

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

virtual	~functionObject ()=default
	Destructor. More...

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

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

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

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

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

Public Member Functions inherited from PtrList< sampledSurface >
constexpr	PtrList () noexcept
	Default construct. More...

	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrList (const PtrList< sampledSurface > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< sampledSurface > &&list)
	Move construct. More...

	PtrList (UList< sampledSurface * > &list)
	Take ownership of pointers in the list, set old pointers to null. More...

	PtrList (const PtrList< sampledSurface > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

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

	PtrList (const SLPtrList< sampledSurface > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T> More...

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

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

	~PtrList ()
	Destructor. More...

PtrList< sampledSurface >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

Foam::PtrList< sampledSurface >	clone (Args &&... args) const

const sampledSurface *	set (const label i) const
	Return const pointer to element (can be nullptr),. More...

autoPtr< sampledSurface >	set (const label i, sampledSurface *ptr)
	Set element to given pointer and return old element (can be null) More...

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

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

autoPtr< sampledSurface >	set (const label i, std::unique_ptr< sampledSurface > &&ptr)
	Set element to given unique_ptr and return old element. More...

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

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

void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...

void	resize (const label newLen)
	Adjust size of PtrList. More...

void	setSize (const label newLen)
	Same as resize() More...

void	emplace_append (Args &&... args)
	Construct and append an element to the end of the list. More...

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

void	append (autoPtr< sampledSurface > &ptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< sampledSurface > &&ptr)
	Move append an element to the end of the list. More...

void	append (std::unique_ptr< sampledSurface > &&ptr)
	Move append an element to the end of the list. More...

void	append (const refPtr< sampledSurface > &ptr)
	Move or clone append a refPtr to the end of the list. More...

void	append (const tmp< sampledSurface > &ptr)
	Move or clone append a tmp to the end of the list. More...

autoPtr< sampledSurface >	emplace (const label i, Args &&... args)
	Construct and set an element. More...

Foam::autoPtr< sampledSurface >	emplace (const label i, Args &&... args)

autoPtr< sampledSurface >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	transfer (PtrList< sampledSurface > &list)
	Transfer into this list and annul the argument list. More...

void	operator= (const PtrList< sampledSurface > &list)
	Copy assignment. More...

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

Static Public Member Functions
static scalar	mergeTol ()
	Get merge tolerance. More...

static scalar	mergeTol (const scalar tol)
	Set merge tolerance and return old value. More...

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

Additional Inherited Members
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

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

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name. More...

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

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

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Member Functions inherited from PtrList< sampledSurface >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...

void	free ()
	Delete the allocated entries, but retain the list size. More...

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

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

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

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Detailed Description

Set of surfaces to sample.

The write() method is used to sample and write files.

Example of function object specification:

surfaces
{
    type    surfaces;
    libs    (sampling);

    // Write at same frequency as fields
    writeControl    outputTime;
    writeInterval   1;

    // Fields to be sampled
    fields          (p U);

    // Scheme to obtain face centre value
    sampleScheme    cell;

    // Scheme to obtain node values
    // (only used if interpolate=true for the surfaces below)
    interpolationScheme cell;

    // Optional: registry storage
    store           true

    // Output surface format
    surfaceFormat   vtk;

    formatOptions
    {
        vtk
        {
            precision  10;
        }
    }

    surfaces
    {
        f0surf
        {
            type        meshedSurface;
            surface     f0surf.obj;
            source      cells;

            // Optional: keep original regions
            keepIds     true;

            // Optional: generate values on points instead of faces
            interpolate true;

            // Optional: alternative output type
            surfaceFormat   ensight;

            // Optional: registry storage
            store       true
        }
    }
}

Entries:

Property	Description	Required	Default
`type`	Type-name: surfaces	yes
`surfaces`	Dictionary or list of sample surfaces	expected
`fields`	word/regex list of fields to sample	yes
`sampleScheme`	scheme to obtain face centre value	no	cell
`interpolationScheme`	scheme to obtain node values	no	cellPoint
`surfaceFormat`	output surface format	yes
`formatOptions`	dictionary of format options	no
`sampleOnExecute`	Sample (store) on execution as well	no	false
`store`	Store surface/fields on registry	no	false

Additional per-surface entries:

Property	Description	Required
`store`	Store surface/fields on registry	no
`surfaceFormat`	output surface format	no
`formatOptions`	dictionary of format options	no
`surfMeshStore`	Store surface/fields as surfMesh (transitional)	no

Note: The interpolationScheme is only used if interpolate=true is used by any of the surfaces.

Source files

Definition at line 223 of file sampledSurfaces.H.

Constructor & Destructor Documentation

◆ sampledSurfaces() [1/2]

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

Construct from Time and dictionary.

Definition at line 213 of file sampledSurfaces.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ sampledSurfaces() [2/2]

sampledSurfaces	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const bool	loadFromFiles = `false`
	)

Construct for given objectRegistry and dictionary.

allow the possibility to load fields from files

Definition at line 242 of file sampledSurfaces.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~sampledSurfaces()

virtual ~sampledSurfaces ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaces" )

Runtime type information.

◆ verbose()

bool verbose ( const bool on )

Enable/disable verbose output.

Returns: old value

Definition at line 273 of file sampledSurfaces.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the sampledSurfaces dictionary.

Reimplemented from regionFunctionObject.

Definition at line 281 of file sampledSurfaces.C.

References PtrList< T >::clear(), Foam::expressions::patchExpr::debug, dict, entry::dict(), sampledSurface::enabled(), Foam::endl(), dictionary::findEntry(), forAll, formatOptions, dictionary::get(), dictionary::getOrDefault(), IOobject::groupName(), Foam::Info, Foam::input(), UPstream::master(), Foam::name(), sampledSurface::New(), Foam::nl, word::null, Foam::Pout, Foam::blockMeshTools::read(), dictionary::readEntry(), PtrList< T >::resize(), s, dictionary::subOrEmptyDict(), and Foam::Zero.

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Sample and store if the sampleOnExecute is enabled.

Implements functionObject.

Definition at line 646 of file sampledSurfaces.C.

◆ write()

bool write ( )

virtual

Sample and write.

Implements functionObject.

Definition at line 657 of file sampledSurfaces.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update for changes of mesh - expires the surfaces.

Reimplemented from functionObject.

Definition at line 663 of file sampledSurfaces.C.

References mapPolyMesh::mesh().

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 674 of file sampledSurfaces.C.

References mesh.

◆ readUpdate()

void readUpdate ( const polyMesh::readUpdateState state )

virtual

Update for changes of mesh due to readUpdate - expires the surfaces.

Definition at line 683 of file sampledSurfaces.C.

References polyMesh::UNCHANGED.

◆ mergeTol() [1/2]

Foam::scalar mergeTol ( )

static

Get merge tolerance.

Definition at line 764 of file sampledSurfaces.C.

◆ mergeTol() [2/2]

Foam::scalar mergeTol ( const scalar tol )

static

Set merge tolerance and return old value.

Definition at line 770 of file sampledSurfaces.C.

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

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledSurfaces() [1/2]

◆ sampledSurfaces() [2/2]

◆ ~sampledSurfaces()

Member Function Documentation

◆ TypeName()

◆ verbose()

◆ read()

◆ execute()

◆ write()

◆ updateMesh()

◆ movePoints()

◆ readUpdate()

◆ mergeTol() [1/2]

◆ mergeTol() [2/2]