#include <DMD.h>

Public Member Functions
	DMD (int dim)
	Constructor. More...

void	takeSample (double *u_in)
	Sample the new state, u_in. More...

void	train (double energy_fraction)

void	train (int k)

void	projectInitialCondition (const Vector *init)
	Predict new initial condition using d_phi. More...

Vector *	predict (double n)
	Predict state given a time. Uses the projected initial condition of the training dataset (the first column). More...

Vector *	predict (const std::pair< Vector , Vector > init, double n)
	Predict state given a new initial condition and time. The initial condition must be projected using projectInitialCondition for correct results. More...

const Matrix *	getSnapshotMatrix ()
	Get the snapshot matrix contained within d_snapshots.

Detailed Description

Class DMD implements the DMD algorithm on a given snapshot matrix.

Constructor & Destructor Documentation

CAROM::DMD::DMD ( int dim )

Constructor.

Parameters

[in] dim The full-order state dimension.

Vector* CAROM::DMD::predict ( double n )

Predict state given a time. Uses the projected initial condition of the training dataset (the first column).

Parameters

[in] n The time of the outputted state (t/dt)

Predict state given a new initial condition and time. The initial condition must be projected using projectInitialCondition for correct results.

Parameters

[in]	init	The initial condition.
[in]	n	The time of the outputted state (t/dt)

void CAROM::DMD::projectInitialCondition ( const Vector * init )

Predict new initial condition using d_phi.

Parameters

[in] init The initial condition.

void CAROM::DMD::takeSample ( double * u_in )

Sample the new state, u_in.

Parameters

[in] u_in The state at the specified time.

void CAROM::DMD::train ( double energy_fraction )

Parameters

[in] energy_fraction The energy fraction to keep after doing SVD.

void CAROM::DMD::train ( int k )

Parameters

[in] k The number of modes (eigenvalues) to keep after doing SVD.

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