#include <BasisReader.h>

Public Member Functions
	BasisReader (const std::string &base_file_name, Database::formats db_format=Database::formats::HDF5, const int dim=-1, MPI_Comm comm=MPI_COMM_WORLD)
	The constructor for the BasisReader class takes the base part of the name of the files holding the basis vectors and the file format. More...

	~BasisReader ()
	Destructor.

std::unique_ptr< Matrix >	getSpatialBasis ()
	Returns the spatial basis vectors as a Matrix. More...

std::unique_ptr< Matrix >	getSpatialBasis (int n)
	Returns the first n spatial basis vectors for the requested time as a Matrix. More...

std::unique_ptr< Matrix >	getSpatialBasis (int start_col, int end_col)
	Returns spatial basis vectors from start_col to end_col for the requested time as a Matrix. More...

std::unique_ptr< Matrix >	getSpatialBasis (double ef)
	Returns the first n spatial basis vectors for the requested time as a Matrix that capture the given energy fraction. More...

std::unique_ptr< Matrix >	getTemporalBasis ()
	Returns the temporal basis vectors for the requested time as a Matrix. More...

std::unique_ptr< Matrix >	getTemporalBasis (int n)
	Returns the first n temporal basis vectors for the requested time as a Matrix. More...

std::unique_ptr< Matrix >	getTemporalBasis (int start_col, int end_col)
	Returns temporal basis vectors from start_col to end_col for the requested time as a Matrix. More...

std::unique_ptr< Matrix >	getTemporalBasis (double ef)
	Returns the first n temporal basis vectors for the requested time as a Matrix that capture the given energy fraction. More...

std::unique_ptr< Vector >	getSingularValues ()
	Returns the singular values for the requested time. More...

std::unique_ptr< Vector >	getSingularValues (double ef)
	Returns the largest singular values for the requested time that capture the given energy fraction. More...

int	getDim (const std::string kind)
	Returns the dimension of the system on this processor. More...

int	getNumSamples (const std::string kind)
	Returns the number of samples (columns) in file. More...

std::unique_ptr< Matrix >	getSnapshotMatrix ()
	Returns the snapshot matrix for the requested time. More...

std::unique_ptr< Matrix >	getSnapshotMatrix (int n)
	Returns the first n columns of the snapshot matrix for the requested time. More...

std::unique_ptr< Matrix >	getSnapshotMatrix (int start_col, int end_col)
	Returns the snapshot matrix from start_col to end_col for the requested time. More...

Detailed Description

Class BasisReader reads the basis vectors from a file written by class BasisWriter.

See also: BasisWriter

Definition at line 34 of file BasisReader.h.

Constructor & Destructor Documentation

◆ BasisReader()

CAROM::BasisReader::BasisReader	(	const std::string &	base_file_name,
		Database::formats	db_format = `Database::formats::HDF5`,
		const int	dim = `-1`,
		MPI_Comm	comm = `MPI_COMM_WORLD`
	)

The constructor for the BasisReader class takes the base part of the name of the files holding the basis vectors and the file format.

Precondition: !base_file_name.empty()

Parameters

[in]	base_file_name	The base part of the name of the files holding the basis vectors.
[in]	db_format	Format of the file to read. One of the implemented file formats defined in Database.
[in]	dim	Number of rows of basis that will be read from a file. If negative, will use the dimension from the rank-specific local file.

Definition at line 23 of file BasisReader.cpp.

Member Function Documentation

◆ getDim()

int CAROM::BasisReader::getDim ( const std::string kind )

Returns the dimension of the system on this processor.

Parameters

[in] kind Type of matrix whose row-dimension is returned. "basis" - local dimension of spatial basis "snapshot" - local dimension of snapshot matrix "temporal_basis" - global dimension of temporal basis

Returns: The dimension of the system on this processor.

Definition at line 276 of file BasisReader.cpp.

◆ getNumSamples()

int CAROM::BasisReader::getNumSamples ( const std::string kind )

Returns the number of samples (columns) in file.

Returns: The number of samples in file.

Definition at line 307 of file BasisReader.cpp.

◆ getSingularValues() [1/2]

std::unique_ptr< Vector > CAROM::BasisReader::getSingularValues ( )

Returns the singular values for the requested time.

Returns: The temporal basis vectors for the requested time.

Definition at line 226 of file BasisReader.cpp.

◆ getSingularValues() [2/2]

std::unique_ptr< Vector > CAROM::BasisReader::getSingularValues ( double ef )

Returns the largest singular values for the requested time that capture the given energy fraction.

Precondition: 0 <= ef <= 1.0

Parameters

[in] ef The desired energy fraction.

Returns: The temporal basis vectors for the requested time.

Definition at line 243 of file BasisReader.cpp.

◆ getSnapshotMatrix() [1/3]

std::unique_ptr< Matrix > CAROM::BasisReader::getSnapshotMatrix ( )

Returns the snapshot matrix for the requested time.

Returns: The snapshot matrix for the requested time.

Definition at line 327 of file BasisReader.cpp.

◆ getSnapshotMatrix() [2/3]

std::unique_ptr< Matrix > CAROM::BasisReader::getSnapshotMatrix ( int n )

Returns the first n columns of the snapshot matrix for the requested time.

Precondition: 0 < n <= numColumns()

Parameters

[in] n The number of basis vectors desired.

Returns: The snapshot matrix for the requested time.

Definition at line 343 of file BasisReader.cpp.

◆ getSnapshotMatrix() [3/3]

std::unique_ptr< Matrix > CAROM::BasisReader::getSnapshotMatrix	(	int	start_col,
		int	end_col
	)

Returns the snapshot matrix from start_col to end_col for the requested time.

Precondition: 0 < start_col <= numColumns(); start_col <= end_col <= numColumns()

Parameters

[in]	start_col	The starting column desired.
[in]	end_col	The final column desired.

Returns: The snapshot matrix for the requested time.

Definition at line 350 of file BasisReader.cpp.

◆ getSpatialBasis() [1/4]

std::unique_ptr< Matrix > CAROM::BasisReader::getSpatialBasis ( )

Returns the spatial basis vectors as a Matrix.

Returns: The spatial basis vectors.

Definition at line 79 of file BasisReader.cpp.

◆ getSpatialBasis() [2/4]

std::unique_ptr< Matrix > CAROM::BasisReader::getSpatialBasis ( double ef )

Returns the first n spatial basis vectors for the requested time as a Matrix that capture the given energy fraction.

Precondition: 0 <= ef <= 1.0

Parameters

[in] ef The desired energy fraction.

Returns: The spatial basis vectors for the requested time.

Definition at line 127 of file BasisReader.cpp.

◆ getSpatialBasis() [3/4]

std::unique_ptr< Matrix > CAROM::BasisReader::getSpatialBasis ( int n )

Returns the first n spatial basis vectors for the requested time as a Matrix.

Precondition: 0 < n <= numColumns()

Parameters

[in] n The number of spatial basis vectors desired.

Returns: The spatial basis vectors for the requested time.

Definition at line 94 of file BasisReader.cpp.

◆ getSpatialBasis() [4/4]

std::unique_ptr< Matrix > CAROM::BasisReader::getSpatialBasis	(	int	start_col,
		int	end_col
	)

Returns spatial basis vectors from start_col to end_col for the requested time as a Matrix.

Precondition: 0 < start_col <= numColumns(); start_col <= end_col <= numColumns()

Parameters

[in]	start_col	The starting column desired.
[in]	end_col	The final column desired.

Returns: The spatial basis vectors for the requested time.

Definition at line 101 of file BasisReader.cpp.

◆ getTemporalBasis() [1/4]

std::unique_ptr< Matrix > CAROM::BasisReader::getTemporalBasis ( )

Returns the temporal basis vectors for the requested time as a Matrix.

Returns: The temporal basis vectors for the requested time.

Definition at line 153 of file BasisReader.cpp.

◆ getTemporalBasis() [2/4]

std::unique_ptr< Matrix > CAROM::BasisReader::getTemporalBasis ( double ef )

Returns the first n temporal basis vectors for the requested time as a Matrix that capture the given energy fraction.

Precondition: 0 <= ef <= 1.0

Parameters

[in] ef The desired energy fraction.

Returns: The temporal basis vectors for the requested time.

Definition at line 200 of file BasisReader.cpp.

◆ getTemporalBasis() [3/4]

std::unique_ptr< Matrix > CAROM::BasisReader::getTemporalBasis ( int n )

Returns the first n temporal basis vectors for the requested time as a Matrix.

Precondition: 0 < n <= numColumns()

Parameters

[in] n The number of temporal basis vectors desired.

Returns: The temporal basis vectors for the requested time.

Definition at line 168 of file BasisReader.cpp.

◆ getTemporalBasis() [4/4]

std::unique_ptr< Matrix > CAROM::BasisReader::getTemporalBasis	(	int	start_col,
		int	end_col
	)

Returns temporal basis vectors from start_col to end_col for the requested time as a Matrix.

Precondition: 0 < start_col <= numColumns(); start_col <= end_col <= numColumns()

Parameters

[in]	start_col	The starting column desired.
[in]	end_col	The final column desired.

Returns: The temporal basis vectors for the requested time.

Definition at line 175 of file BasisReader.cpp.

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

lib/linalg/BasisReader.h
lib/linalg/BasisReader.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BasisReader()

Member Function Documentation

◆ getDim()

◆ getNumSamples()

◆ getSingularValues() [1/2]

◆ getSingularValues() [2/2]

◆ getSnapshotMatrix() [1/3]

◆ getSnapshotMatrix() [2/3]

◆ getSnapshotMatrix() [3/3]

◆ getSpatialBasis() [1/4]

◆ getSpatialBasis() [2/4]

◆ getSpatialBasis() [3/4]

◆ getSpatialBasis() [4/4]

◆ getTemporalBasis() [1/4]

◆ getTemporalBasis() [2/4]

◆ getTemporalBasis() [3/4]

◆ getTemporalBasis() [4/4]