sampledSets Class Reference

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

Inheritance diagram for sampledSets:

[legend]

Collaboration diagram for sampledSets:

[legend]

List of all members.

Classes
class	fieldGroup
	Class used for grouping field types.
class	volFieldSampler
	Class used for sampling volFields.
Public Member Functions
	TypeName ("sets")
	Runtime type information.
	sampledSets (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
	Construct for given objectRegistry and dictionary.
virtual	~sampledSets ()
virtual const word &	name () const
	Return name of the set of probes.
void	verbose (const bool verbosity=true)
	set verbosity level
virtual void	execute ()
	Execute, currently does nothing.
virtual void	end ()
	Execute at the final time-loop, currently does nothing.
virtual void	write ()
	Sample and write.
virtual void	read (const dictionary &)
	Read the sampledSets.
void	correct ()
	Correct for mesh changes.
virtual void	updateMesh (const mapPolyMesh &)
	Update for changes of mesh.
virtual void	movePoints (const pointField &)
	Update for mesh point-motion.
virtual void	readUpdate (const polyMesh::readUpdateState state)
	Update for changes of mesh due to readUpdate.

---

Detailed Description

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

Source files

• sampledSets.H
• sampledSets.C

Definition at line 54 of file sampledSets.H.

---

Constructor & Destructor Documentation

sampledSets	(	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 217 of file sampledSets.C.

~sampledSets

(

)

[virtual]

Definition at line 253 of file sampledSets.C.

---

Member Function Documentation

TypeName

(

"sets"

)

Runtime type information.

virtual const word& name

(

)

const [inline, virtual]

Return name of the set of probes.

Definition at line 267 of file sampledSets.H.

void verbose

(

const bool

verbosity = true

)

set verbosity level

Definition at line 259 of file sampledSets.C.

void execute

(

)

[virtual]

Execute, currently does nothing.

Definition at line 265 of file sampledSets.C.

void end

(

)

[virtual]

Execute at the final time-loop, currently does nothing.

Reimplemented from PtrList< sampledSet >.

Definition at line 271 of file sampledSets.C.

void write

(

)

[virtual]

Sample and write.

Definition at line 277 of file sampledSets.C.

void read

(

const dictionary &

dict

)

[virtual]

Read the sampledSets.

Definition at line 290 of file sampledSets.C.

void correct

(

)

Correct for mesh changes.

Definition at line 329 of file sampledSets.C.

References Foam::endl(), PtrList< sampledSet >::operator[](), and Foam::Pout.

Here is the call graph for this function:

void updateMesh

(

const mapPolyMesh &

)

[virtual]

Update for changes of mesh.

Definition at line 347 of file sampledSets.C.

void movePoints

(

const pointField &

)

[virtual]

Update for mesh point-motion.

Definition at line 353 of file sampledSets.C.

void readUpdate

(

const polyMesh::readUpdateState

state

)

[virtual]

Update for changes of mesh due to readUpdate.

Definition at line 359 of file sampledSets.C.

---

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/sampledSetsTemplates.C