Abstract base class for DMD models to handle DMD characteristics for the DMD function object. More...

#include <DMDModel.H>

Inheritance diagram for DMDModel:

[legend]

Collaboration diagram for DMDModel:

[legend]

Public Member Functions
	TypeName ("DMDModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, DMDModel, dictionary,(const fvMesh &mesh, const word &name, const dictionary &dict),(mesh, name, dict))
	DMDModel (const fvMesh &mesh, const word &name, const dictionary &dict)
	Construct from components.
	DMDModel (const DMDModel &)=delete
	No copy construct.
void	operator= (const DMDModel &)=delete
	No copy assignment.
virtual	~DMDModel ()=default
	Destructor.
virtual bool	initialise (const RMatrix &snapshot)=0
	Initialise model data members with a given snapshot.
virtual bool	update (const RMatrix &snapshot)=0
	Update model data members with a given snapshot.
virtual bool	fit ()=0
	Compute and write modes and mode dynamics of model data members.
virtual void	reconstruct (const wordList modes)
	Compute and write a reconstruction of flow field based on given modes and mode dynamics (currently no-op).
virtual bool	read (const dictionary &dict)=0
	Read model settings.
Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName.
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary.
	writeFile (const writeFile &wf)
	Construct copy.
virtual	~writeFile ()=default
	Destructor.
virtual const string &	setExt (const string &ext)
	Set extension.
virtual OFstream &	file ()
	Return access to the file (if only 1).
virtual bool	writeToFile () const
	Flag to allow writing to file.
virtual bool	canWriteToFile () const
	Flag to allow writing to the file.
virtual bool	canResetFile () const
	Flag to allow resetting the file.
virtual bool	canWriteHeader () const
	Flag to allow writing the header.
virtual label	charWidth () const
	Return width of character stream output.
virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream.
virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream.
virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream.
virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream.
virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream.
template<class Type>
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair.
template<class Type>
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter.

Static Public Member Functions
static autoPtr< DMDModel >	New (const fvMesh &mesh, const word &name, const dictionary &dict)
	Return a reference to the selected DMD model.

Protected Member Functions
virtual bool	dynamics ()=0
	Compute and write mode dynamics.
virtual bool	modes ()=0
	Compute and write modes.
Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing.
fileName	baseFileDir () const
	Return the base directory for output.
fileName	baseTimeDir () const
	Return the base directory for the current time value.
fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name.
virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name.
virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time.
virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name.
Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset.
void	operator= (const writeFile &)=delete
	No copy assignment.
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time.

Protected Attributes
const fvMesh &	mesh_
	Reference to the mesh.
const word	name_
	Name of operand function object.
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry.
const fileName	prefix_
	Prefix.
word	fileName_
	Name of file.
autoPtr< OFstream >	filePtr_
	File pointer.
label	writePrecision_
	Write precision.
bool	writeToFile_
	Flag to enable/disable writing to file.
bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true.
bool	writtenHeader_
	Flag to identify whether the header has been written.
bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true.
scalar	startTime_
	Start time value.
string	ext_
	File extension; default = .dat.

Additional Inherited Members
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.

Detailed Description

Abstract base class for DMD models to handle DMD characteristics for the DMD function object.

Source files

Definition at line 62 of file DMDModel.H.

Constructor & Destructor Documentation

◆ DMDModel() [1/2]

DMDModel	(	const fvMesh &	mesh,
		const word &	name,
		const dictionary &	dict )

Construct from components.

Definition at line 34 of file DMDModel.C.

References dict, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, mesh, mesh_, Foam::name(), name_, and writeFile::writeFile().

Referenced by declareRunTimeSelectionTable(), DMDModel(), operator=(), and STDMD::STDMD().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DMDModel() [2/2]

DMDModel ( const DMDModel & )

delete

No copy construct.

References DMDModel().

Here is the call graph for this function:

◆ ~DMDModel()

virtual ~DMDModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ dynamics()

virtual bool dynamics ( )

protectedpure virtual

Compute and write mode dynamics.

◆ modes()

virtual bool modes ( )

protectedpure virtual

Compute and write modes.

Referenced by reconstruct().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "DMDModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		DMDModel	,
		dictionary	,
		(const fvMesh &mesh, const word &name, const dictionary &dict)	,
		(mesh, name, dict)	)

References dict, DMDModel(), mesh, and Foam::name().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::DMDModel > New	(	const fvMesh &	mesh,
		const word &	name,
		const dictionary &	dict )

static

Return a reference to the selected DMD model.

Definition at line 25 of file DMDModelNew.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, mesh, and Foam::name().

Here is the call graph for this function:

◆ operator=()

void operator= ( const DMDModel & )

delete

No copy assignment.

References DMDModel().

Here is the call graph for this function:

◆ initialise()

virtual bool initialise ( const RMatrix & snapshot )

pure virtual

Initialise model data members with a given snapshot.

Implemented in STDMD.

◆ update()

virtual bool update ( const RMatrix & snapshot )

pure virtual

Update model data members with a given snapshot.

Implemented in STDMD.

◆ fit()

virtual bool fit ( )

pure virtual

Compute and write modes and mode dynamics of model data members.

Implemented in STDMD.

◆ reconstruct()

virtual void reconstruct ( const wordList modes )

inlinevirtual

Compute and write a reconstruction of flow field based on given modes and mode dynamics (currently no-op).

Definition at line 190 of file DMDModel.H.

References modes(), and NotImplemented.

Here is the call graph for this function:

◆ read()

virtual bool read ( const dictionary & dict )

pure virtual

Read model settings.

Reimplemented from writeFile.

Implemented in STDMD.

References dict.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to the mesh.

Definition at line 77 of file DMDModel.H.

Referenced by DMDModel(), STDMD::initialise(), and STDMD::read().

◆ name_

const word name_

protected

Name of operand function object.

Definition at line 82 of file DMDModel.H.

Referenced by DMDModel(), and STDMD::initialise().

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

src/functionObjects/field/DMD/DMDModels/DMDModel/DMDModel.H
src/functionObjects/field/DMD/DMDModels/DMDModel/DMDModel.C
src/functionObjects/field/DMD/DMDModels/DMDModel/DMDModelNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DMDModel() [1/2]

◆ DMDModel() [2/2]

◆ ~DMDModel()

Member Function Documentation

◆ dynamics()

◆ modes()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ operator=()

◆ initialise()

◆ update()

◆ fit()

◆ reconstruct()

◆ read()

Member Data Documentation

◆ mesh_

◆ name_