DMD Class Reference

Field creation model using the streaming total dynamic mode decomposition method (STDMD). More...

Inheritance diagram for DMD:
Collaboration diagram for DMD:

Public Member Functions

 TypeName ("DMD")
 Runtime type information. More...
 
 DMD (Time &runTime, fvMesh &mesh, const dictionary &dict, const instantList &times)
 Construct from components. More...
 
 DMD (const DMD &)=delete
 No copy construct. More...
 
void operator= (const DMD &)=delete
 No copy assignment. More...
 
virtual ~DMD ()=default
 Destructor. More...
 
virtual bool read (const dictionary &dict)
 Read model settings. More...
 
virtual bool createAndWrite ()
 Create and write fields. More...
 
- Public Member Functions inherited from ROMmodel
 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from ROMmodel
static autoPtr< ROMmodelNew (Time &runTime, fvMesh &mesh, const dictionary &dict, const instantList &times)
 Return a reference to the selected ROMmodel. More...
 
- Protected Attributes inherited from ROMmodel
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

Field creation model using the streaming total dynamic mode decomposition method (STDMD).

The governing equations of the field creation are as follows:

\[ \mathbf{x}_\tau \approx \tilde{\mathbf{x}_\tau} = \left( \sum_{i=0}^{N-1} \phi_i \alpha_i v_i^\tau \right)_{real}​ \]

with

\[ \tau = \frac{t - t_o}{\Delta t}​ \]

where:

$ \mathbf{x} $ = Field snapshot at time t
$ \tilde{\mathbf{x}} $ = Reconstructed field snapshot at time t (complex)
$ N $ = Number of modes
$ i $ = Mode index
$ \tau $ = Nondimensional time
$ t $ = Time [s]
$ t_o $ = Start time (of mode decomposition calculations) [s]
$ \Delta t $ = Time-step size of mode decomposition [s]
$ \phi $ = Mode (complex)
$ \alpha $ = Mode amplitude (complex)
$ v $ = Mode eigenvalue (complex)

References:

        Governing equations (tag:K):
            Kiewat, M. (2019).
            Streaming modal decomposition approaches for vehicle aerodynamics.
            PhD thesis. Munich: Technical University of Munich.
            URL:mediatum.ub.tum.de/doc/1482652/1482652.pdf

Operands:

Operand Type Location
input {vol,surface}<Type>Field <time>/<inpField>
output file - -
output field {vol,surface}<Type>Field <time>/<outField>

where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.

Usage
Minimal example by using system/ROMfieldsDict:
    // Mandatory entries
    field           <word>;
    object          <word>;
    deltaT          <scalar>;
    time            <scalar>;
    modes           <labelList>;
    amplitudes      <complexList>;
    eigenvalues     <complexList>;

    // Optional entries
    startTime       <scalar>;
    dimensions      <dimensionSet>;

where the entries mean:

Property Description Type Reqd Deflt
field Name of reconstructed field word yes -
object Name of operand function object word yes -
deltaT Time-step size of mode decomposition scalar yes -
time Time instant where modes are located scalar yes -
modes List of mode indices labelList yes -
amplitudes Amplitude coefficients complexList yes -
eigenvalues Eigenvalues complexList yes -
startTime Start time for mode-information collection scalar no 0
dimensions Dimensions of reconstructed fields dimensionSet no -
Source files

Definition at line 251 of file DMD.H.

Constructor & Destructor Documentation

◆ DMD() [1/2]

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

Construct from components.

◆ DMD() [2/2]

DMD ( const DMD )
delete

No copy construct.

◆ ~DMD()

virtual ~DMD ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "DMD"  )

Runtime type information.

◆ operator=()

void operator= ( const DMD )
delete

No copy assignment.

◆ read()

virtual bool read ( const dictionary dict)
virtual

Read model settings.

Implements ROMmodel.

◆ createAndWrite()

virtual bool createAndWrite ( )
virtual

Create and write fields.

Implements ROMmodel.


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