Options.h

 
// Description: A class defining the parameters to the BasisGenerator class and
// SVD algorithm.
 
#ifndef included_Options_h
#define included_Options_h
 
#include "utils/Utilities.h"
 
namespace CAROM {
 
class Options
{
public:
    Options(int dim_,
            int max_num_samples_,
            bool update_right_SV_ = false,
            bool write_snapshots_ = false
           ): dim(dim_),
        max_basis_dimension(max_num_samples_),
        max_num_samples(max_num_samples_),
        update_right_SV(update_right_SV_),
        write_snapshots(write_snapshots_)
    {};
 
    Options setMaxBasisDimension(
        int max_basis_dimension_
    )
    {
        max_basis_dimension = max_basis_dimension_;
        return *this;
    }
 
    Options setSingularValueTol(
        double singular_value_tol_
    )
    {
        singular_value_tol = singular_value_tol_;
        return *this;
    }
 
    Options setDebugMode(
        bool debug_algorithm_
    )
    {
        debug_algorithm = debug_algorithm_;
        return *this;
    }
 
    Options setRandomizedSVD(
        bool randomized_,
        int randomized_subspace_dim_ = -1,
        int random_seed_ = 1
    )
    {
        randomized = randomized_;
        randomized_subspace_dim = randomized_subspace_dim_;
        random_seed = random_seed_;
        return *this;
    }
 
    Options setIncrementalSVD(
        double linearity_tol_,
        double initial_dt_,
        double sampling_tol_,
        double max_time_between_samples_,
        bool fast_update_ = false,
        bool fast_update_brand_ = false,
        bool skip_linearly_dependent_ = false
    )
    {
        linearity_tol = linearity_tol_;
        initial_dt = initial_dt_;
        sampling_tol = sampling_tol_;
        max_time_between_samples = max_time_between_samples_;
        fast_update = fast_update_;
        fast_update_brand = fast_update_brand_;
        skip_linearly_dependent = skip_linearly_dependent_;
        return *this;
    }
 
    Options setStateIO(
        bool save_state_,
        bool restore_state_
    )
    {
        save_state = save_state_;
        restore_state = restore_state_;
        return *this;
    }
 
    Options setSamplingTimeStepScale(
        double min_sampling_time_step_scale_,
        double sampling_time_step_scale_,
        double max_sampling_time_step_scale_
    )
    {
        min_sampling_time_step_scale = min_sampling_time_step_scale_;
        sampling_time_step_scale = sampling_time_step_scale_;
        max_sampling_time_step_scale = max_sampling_time_step_scale_;
        return *this;
    }
 
    int dim = -1;
 
    int max_num_samples = -1;
 
    bool update_right_SV = false;
 
    bool write_snapshots = false;
 
    int max_basis_dimension = -1;
 
    double singular_value_tol = 0;
 
    bool debug_algorithm = false;
 
    // Randomized SVD
 
    bool randomized = false;
 
    int randomized_subspace_dim = -1;
 
    int random_seed = 1;
 
    // Incremental SVD
 
    double linearity_tol = -1;
 
    double initial_dt = -1;
 
    double sampling_tol = -1;
 
    double max_time_between_samples = -1;
 
    bool fast_update = false;
 
    bool fast_update_brand = false;
 
    bool skip_linearly_dependent = false;
 
    bool save_state = false;
 
    bool restore_state = false;
 
    double min_sampling_time_step_scale = 0.1;
 
    double sampling_time_step_scale = 0.8;
 
    double max_sampling_time_step_scale = 5.0;
 
    bool static_svd_preserve_snapshot = false;
};
 
}
 
#endif