Loading...
Searching...
No Matches
ROMmodel Class Referenceabstract

Abstract base class for reduced-order models to handle specific model characteristics. More...

#include <ROMmodel.H>

Inheritance diagram for ROMmodel:
Collaboration diagram for ROMmodel:

Public Member Functions

 TypeName ("ROMmodel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, ROMmodel, dictionary,(Time &runTime, fvMesh &mesh, const dictionary &dict, const instantList &times),(runTime, mesh, dict, times))
 ROMmodel (Time &runTime, fvMesh &mesh, const dictionary &dict, const instantList &times)
 Construct from components.
 ROMmodel (const ROMmodel &)=delete
 No copy construct.
void operator= (const ROMmodel &)=delete
 No copy assignment.
virtual ~ROMmodel ()=default
 Destructor.
virtual bool read (const dictionary &dict)=0
 Read model settings.
virtual bool createAndWrite ()=0
 Create and write fields.

Static Public Member Functions

static autoPtr< ROMmodelNew (Time &runTime, fvMesh &mesh, const dictionary &dict, const instantList &times)
 Return a reference to the selected ROMmodel.

Protected Attributes

TimerunTime_
 Reference to the Time.
fvMeshmesh_
 Reference to the fvMesh.
const dictionarydict_
 Const reference to the dictionary.
const instantListtimes_
 Const reference to field times.

Detailed Description

Abstract base class for reduced-order models to handle specific model characteristics.

Source files

Definition at line 63 of file ROMmodel.H.

Constructor & Destructor Documentation

◆ ROMmodel() [1/2]

ROMmodel ( Time & runTime,
fvMesh & mesh,
const dictionary & dict,
const instantList & times )

Construct from components.

References dict, mesh, and runTime.

Referenced by declareRunTimeSelectionTable(), operator=(), and ROMmodel().

Here is the caller graph for this function:

◆ ROMmodel() [2/2]

ROMmodel ( const ROMmodel & )
delete

No copy construct.

References ROMmodel().

Here is the call graph for this function:

◆ ~ROMmodel()

virtual ~ROMmodel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "ROMmodel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
ROMmodel ,
dictionary ,
(Time &runTime, fvMesh &mesh, const dictionary &dict, const instantList &times) ,
(runTime, mesh, dict, times)  )

References dict, mesh, ROMmodel(), and runTime.

Here is the call graph for this function:

◆ New()

autoPtr< ROMmodel > New ( Time & runTime,
fvMesh & mesh,
const dictionary & dict,
const instantList & times )
static

Return a reference to the selected ROMmodel.

References dict, mesh, and runTime.

◆ operator=()

void operator= ( const ROMmodel & )
delete

No copy assignment.

References ROMmodel().

Here is the call graph for this function:

◆ read()

virtual bool read ( const dictionary & dict)
pure virtual

Read model settings.

Implemented in DMD.

References dict.

◆ createAndWrite()

virtual bool createAndWrite ( )
pure virtual

Create and write fields.

Implemented in DMD.

Member Data Documentation

◆ runTime_

Time& runTime_
protected

Reference to the Time.

Need non-const access to use setTime

Definition at line 74 of file ROMmodel.H.

◆ mesh_

fvMesh& mesh_
protected

Reference to the fvMesh.

Need non-const access to use readFieldsHandler

Definition at line 81 of file ROMmodel.H.

◆ dict_

const dictionary& dict_
protected

Const reference to the dictionary.

Definition at line 86 of file ROMmodel.H.

◆ times_

const instantList& times_
protected

Const reference to field times.

Definition at line 91 of file ROMmodel.H.


The documentation for this class was generated from the following file:
  • applications/utilities/postProcessing/miscellaneous/createROMfields/ROMmodels/ROMmodel/ROMmodel.H