Set of sets to sample. Call sampledSets.write() to sample and write files. More...

Inheritance diagram for sampledSets:

Collaboration diagram for sampledSets:

Public Member Functions
	TypeName ("sets")

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

	sampledSets (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)

virtual	~sampledSets ()=default

bool	verbose (const bool on)

virtual bool	read (const dictionary &)

virtual bool	execute ()

virtual bool	write ()

void	correct ()

virtual void	updateMesh (const mapPolyMesh &)

virtual void	movePoints (const polyMesh &)

virtual void	readUpdate (const polyMesh::readUpdateState state)

template<class Type >
Foam::fileName	writeSampleFile (const coordSet &masterSampleSet, const PtrList< volFieldSampler< Type >> &masterFields, const label setI, const fileName &timeDir, const writer< Type > &formatter)

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< sampledSet >
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)

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

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 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< sampledSet >
void	readIstream (Istream &is, const INew &inew)

void	free ()

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 sets to sample. Call sampledSets.write() to sample and write files.

Source files

Definition at line 61 of file sampledSets.H.

Constructor & Destructor Documentation

◆ sampledSets() [1/2]

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

Definition at line 80 of file sampledSets.C.

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

Here is the call graph for this function:

◆ sampledSets() [2/2]

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

Definition at line 113 of file sampledSets.C.

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

Here is the call graph for this function:

◆ ~sampledSets()

virtual ~sampledSets ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "sets" )

◆ verbose()

bool verbose ( const bool on )

Definition at line 148 of file sampledSets.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from regionFunctionObject.

Definition at line 211 of file sampledSets.C.

References Foam::expressions::patchExpr::debug, dict, Foam::endl(), forAll, Foam::Info, UPstream::master(), Foam::nl, Foam::Pout, and dictionary::readEntry().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Implements functionObject.

Definition at line 156 of file sampledSets.C.

◆ write()

bool write ( )

virtual

Implements functionObject.

Definition at line 162 of file sampledSets.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Info, UPstream::master(), Foam::mkDir(), Foam::nl, and Foam::Pout.

Here is the call graph for this function:

◆ correct()

void correct ( )

Definition at line 258 of file sampledSets.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Reimplemented from functionObject.

Definition at line 275 of file sampledSets.C.

References correct(), and mapPolyMesh::mesh().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Reimplemented from functionObject.

Definition at line 284 of file sampledSets.C.

References correct(), and mesh.

Here is the call graph for this function:

◆ readUpdate()

void readUpdate ( const polyMesh::readUpdateState state )

virtual

Definition at line 293 of file sampledSets.C.

References correct(), and polyMesh::UNCHANGED.

Here is the call graph for this function:

◆ writeSampleFile()

Foam::fileName writeSampleFile	(	const coordSet &	masterSampleSet,
		const PtrList< volFieldSampler< Type >> &	masterFields,
		const label	setI,
		const fileName &	timeDir,
		const writer< Type > &	formatter
	)

Definition at line 122 of file sampledSetsTemplates.C.

References Foam::average(), Foam::endl(), forAll, writer< Type >::getFileName(), UPstream::master(), Foam::max(), maxValue, Foam::min(), minValue, OFstream::name(), IOstream::opened(), Pstream::scatter(), WarningInFunction, and writer< Type >::write().

Here is the call graph for this function:

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

src/sampling/sampledSet/sampledSets/sampledSets.H
src/sampling/sampledSet/sampledSets/sampledSets.C
src/sampling/sampledSet/sampledSets/sampledSetsGrouping.C
src/sampling/sampledSet/sampledSets/sampledSetsTemplates.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sampledSets() [1/2]

◆ sampledSets() [2/2]

◆ ~sampledSets()

Member Function Documentation

◆ TypeName()

◆ verbose()

◆ read()

◆ execute()

◆ write()

◆ correct()

◆ updateMesh()

◆ movePoints()

◆ readUpdate()

◆ writeSampleFile()