ROMmodel Class Referenceabstract

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

Inheritance diagram for ROMmodel:
Collaboration diagram for ROMmodel:

Public Member Functions

 TypeName ("ROMmodel")
 Runtime type information. More...
 
 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. More...
 
 ROMmodel (const ROMmodel &)=delete
 No copy construct. More...
 
void operator= (const ROMmodel &)=delete
 No copy assignment. More...
 
virtual ~ROMmodel ()=default
 Destructor. More...
 
virtual bool read (const dictionary &dict)=0
 Read model settings. More...
 
virtual bool createAndWrite ()=0
 Create and write fields. More...
 

Static Public Member Functions

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

Protected Attributes

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

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.

◆ ROMmodel() [2/2]

ROMmodel ( const ROMmodel )
delete

No copy construct.

◆ ~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)   
)

◆ New()

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

Return a reference to the selected ROMmodel.

◆ operator=()

void operator= ( const ROMmodel )
delete

No copy assignment.

◆ read()

virtual bool read ( const dictionary dict)
pure virtual

Read model settings.

Implemented in DMD.

◆ 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: