stateModel Class Reference

Base class for models with state. More...

Inheritance diagram for stateModel:

Public Member Functions
	stateModel ()
	Construct null. More...
	stateModel (const stateModel &)=delete
	Disallow default bitwise copy construction. More...
virtual	~stateModel ()
	Destructor. More...
virtual const word &	name () const =0
	Return the model name. More...
virtual const objectRegistry &	db () const =0
	Return the model's database. More...
bool	writeState (const bool write) const
	Write state. More...
virtual void	writeState (Ostream &os) const
	Write state. More...
virtual void	writeProcessorState (Ostream &os) const
	Write processor state. More...
void	operator= (const stateModel &)=delete
	Disallow default bitwise assignment. More...

Static Public Member Functions
static dictionary	stateDict (const word &name, const objectRegistry &db)
	Construct and return the state dictionary for reading. More...

Detailed Description

Base class for models with state.

Source files

• stateModel.H
• stateModel.C

Definition at line 48 of file stateModel.H.

Constructor & Destructor Documentation

stateModel() [1/2]

stateModel

(

)

Construct null.

Definition at line 76 of file stateModel.C.

stateModel() [2/2]

stateModel ( const stateModel &  )

delete

Disallow default bitwise copy construction.

~stateModel()

~stateModel ( )

virtual

Destructor.

Definition at line 82 of file stateModel.C.

Member Function Documentation

name()

virtual const word& name ( ) const

pure virtual

Return the model name.

Implemented in LagrangianModel.

db()

virtual const objectRegistry& db ( ) const

pure virtual

Return the model's database.

Implemented in LagrangianModel.

writeState() [1/2]

bool writeState

(

const bool

write

)

const

Write state.

Definition at line 104 of file stateModel.C.

References UPstream::parRun(), and Foam::vtkWriteOps::write().

Referenced by diskInjection::writeState(), patchInjection::writeState(), pointInjection::writeState(), and volumeInjection::writeState().

Here is the call graph for this function:

Here is the caller graph for this function:

writeState() [2/2]

void writeState ( Ostream &  os ) const

virtual

Write state.

Reimplemented in volumeInjection, pointInjection, patchInjection, and diskInjection.

Definition at line 128 of file stateModel.C.

writeProcessorState()

void writeProcessorState ( Ostream &  os ) const

virtual

Write processor state.

Reimplemented in volumeInjection, turbulentDispersion, and patchInjection.

Definition at line 132 of file stateModel.C.

Referenced by patchInjection::writeProcessorState(), turbulentDispersion::writeProcessorState(), and volumeInjection::writeProcessorState().

Here is the caller graph for this function:

stateDict()

Foam::dictionary stateDict ( const word &  name, const objectRegistry &  db  )

static

Construct and return the state dictionary for reading.

Definition at line 136 of file stateModel.C.

References dictionary::merge(), Foam::name(), and UPstream::parRun().

Here is the call graph for this function:

operator=()

void operator= ( const stateModel &  )

delete

Disallow default bitwise assignment.

---

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

• src/Lagrangian/Lagrangian/stateModel/stateModel.H
• src/Lagrangian/Lagrangian/stateModel/stateModel.C