BasisTemplate#
- class BasisTemplate(name: str = None)[source]#
Template class for bases.
Classes that inherit from this template must implement the methods
fit(),compress(), anddecompress().See
PODBasisfor an example.Properties:- full_state_dimension#
Dimension \(n\) of the full state.
- name#
Label for the state variable that this basis approximates.
- reduced_state_dimension#
Dimension \(r\) of the reduced (compressed) state.
- shape#
Dimensions \((n, r)\) of the basis.
Methods:Map high-dimensional states to low-dimensional latent coordinates.
Make a copy of the basis.
Map low-dimensional latent coordinates to high-dimensional states.
Construct the basis.
Construct the basis and map high-dimensional states to low-dimensional latent coordinates.
Load a transformer from an HDF5 file.
Project a high-dimensional state vector to the subset of the high-dimensional space that can be represented by the basis.
Compute the error of the basis representation of a state or states.
Save the transformer to an HDF5 file.
Verify that
compress()anddecompress()are consistent in the sense that the range ofdecompress()is in the domain ofcompress()and thatproject()defines a projection operator, i.e.,project(project(Q)) = project(Q).