Set of surfaces to sample. More...

Inheritance diagram for sampledSurfaces:

Collaboration diagram for sampledSurfaces:

Public Member Functions
	TypeName ("surfaces")

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

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

virtual	~sampledSurfaces ()=default

bool	verbose (const bool on)

virtual bool	read (const dictionary &dict)

virtual bool	execute ()

virtual bool	write ()

virtual void	updateMesh (const mapPolyMesh &mpm)

virtual void	movePoints (const polyMesh &mesh)

virtual void	readUpdate (const polyMesh::readUpdateState state)

Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")

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

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~fvMeshFunctionObject ()=default

Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")

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

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)

virtual	~regionFunctionObject ()=default

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

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

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)

virtual	~stateFunctionObject ()=default

dictionary &	propertyDict ()

bool	foundProperty (const word &entryName) const

void	clearTrigger ()

label	getTrigger () const

bool	setTrigger (const label triggeri, bool increaseOnly=true)

bool	getDict (const word &entryName, dictionary &dict) const

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getProperty (const word &entryName, Type &value) const

template<class Type >
void	setProperty (const word &entryName, const Type &value)

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)

template<class Type >
void	setResult (const word &entryName, const Type &value)

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)

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

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const

word	resultType (const word &entryName) const

word	objectResultType (const word &objectName, const word &entryName) const

wordList	objectResultEntries () const

wordList	objectResultEntries (const word &objectName) const

void	writeResultEntries (Ostream &os) const

void	writeResultEntries (const word &objectName, Ostream &os) const

void	writeAllResultEntries (Ostream &os) const

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

virtual	~timeFunctionObject ()=default

const Time &	time () const

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)

autoPtr< functionObject >	clone () const

virtual	~functionObject ()=default

virtual const word &	type () const =0

const word &	name () const noexcept

bool	useNamePrefix () const noexcept

bool	useNamePrefix (bool on) noexcept

virtual bool	execute (const label subIndex)

virtual bool	end ()

virtual bool	adjustTimeStep ()

virtual bool	filesModified () const

Public Member Functions inherited from PtrList< sampledSurface >
constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (const PtrList< T > &list, const CloneArg &cloneArgs)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

	PtrList (Istream &is, const INew &inew)

	PtrList (Istream &is)

	PtrList (PtrList< T > &list, bool reuse)

	PtrList (const SLPtrList< T > &list)

constexpr	PtrList () noexcept

	PtrList (const label len)

	PtrList (const PtrList< T > &list)

	PtrList (PtrList< T > &&list)

	PtrList (UList< T * > &list)

	PtrList (Istream &is)

	~PtrList ()

PtrList< T >	clone (Args &&... args) const

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

const T *	set (const label i) const

autoPtr< T >	set (const label i, T *ptr)

autoPtr< T >	set (const label i, autoPtr< T > &ptr)

autoPtr< T >	set (const label i, autoPtr< T > &&ptr)

autoPtr< T >	set (const label i, std::unique_ptr< T > &&ptr)

autoPtr< T >	set (const label i, const refPtr< T > &ptr)

autoPtr< T >	set (const label i, const tmp< T > &ptr)

void	clear ()

void	resize (const label newLen)

void	setSize (const label newLen)

void	emplace_append (Args &&... args)

void	append (T *ptr)

void	append (autoPtr< T > &ptr)

void	append (autoPtr< T > &&ptr)

void	append (std::unique_ptr< T > &&ptr)

void	append (const refPtr< T > &ptr)

void	append (const tmp< T > &ptr)

autoPtr< T >	emplace (const label i, Args &&... args)

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

autoPtr< T >	release (const label i)

void	transfer (PtrList< T > &list)

void	operator= (const PtrList< T > &list)

void	operator= (PtrList< T > &&list)

Static Public Member Functions
static scalar	mergeTol ()

static scalar	mergeTol (const scalar tol)

Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)

Additional Inherited Members
Public Attributes inherited from functionObject
bool	log

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess

static bool	defaultUseNamePrefix

static word	outputPrefix

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete

void	operator= (const fvMeshFunctionObject &)=delete

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const

template<class ObjectType >
bool	foundObject (const word &fieldName) const

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

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)

template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)

bool	writeObject (const word &fieldName)

bool	clearObject (const word &fieldName)

void	clearObjects (const wordList &objNames)

	regionFunctionObject (const regionFunctionObject &)=delete

void	operator= (const regionFunctionObject &)=delete

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const

functionObjects::properties &	stateDict ()

	stateFunctionObject (const stateFunctionObject &)=delete

void	operator= (const stateFunctionObject &)=delete

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)

	timeFunctionObject (const timeFunctionObject &)=delete

void	operator= (const timeFunctionObject &)=delete

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Protected Member Functions inherited from PtrList< sampledSurface >
void	readIstream (Istream &is, const INew &inew)

void	free ()

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_

const objectRegistry &	obr_

const objectRegistry *	obrPtr_

Protected Attributes inherited from timeFunctionObject
const Time &	time_

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 219 of file sampledSurfaces.H.

Constructor & Destructor Documentation

◆ sampledSurfaces() [1/2]

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

Definition at line 206 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`
	)

Definition at line 235 of file sampledSurfaces.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ ~sampledSurfaces()

virtual ~sampledSurfaces ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "surfaces" )

◆ verbose()

bool verbose ( const bool on )

Definition at line 266 of file sampledSurfaces.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from regionFunctionObject.

Definition at line 274 of file sampledSurfaces.C.

References PtrList::clear(), Foam::expressions::patchExpr::debug, dict, entry::dict(), 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::resize(), s, PtrList::set(), dictionary::subOrEmptyDict(), and Foam::Zero.

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Implements functionObject.

Definition at line 639 of file sampledSurfaces.C.

◆ write()

bool write ( )

virtual

Implements functionObject.

Definition at line 650 of file sampledSurfaces.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Reimplemented from functionObject.

Definition at line 656 of file sampledSurfaces.C.

References mapPolyMesh::mesh().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Reimplemented from functionObject.

Definition at line 667 of file sampledSurfaces.C.

References mesh.

◆ readUpdate()

void readUpdate ( const polyMesh::readUpdateState state )

virtual

Definition at line 676 of file sampledSurfaces.C.

References polyMesh::UNCHANGED.

◆ mergeTol() [1/2]

Foam::scalar mergeTol ( )

static

Definition at line 757 of file sampledSurfaces.C.

◆ mergeTol() [2/2]

Foam::scalar mergeTol ( const scalar tol )

static

Definition at line 763 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]