Cyclops Control¶
This module provides a dictionary through which all computational and physical parameters are organised and accessed. All have semi-reasonable default values and may be chosen by the user via the command-line interface.
Functions¶
- make_control : Creates a control object with the default values
- setup_control : Updates the default control object with user selections
Parameters¶
- Nx : Number of gridpoints along one direction. Domain is Nx X Nx square <int>
- Nt : Number of coarse timesteps for APinT computation <int>
- coarse_timestep : Coarse timestep length <float>
- fine_timestep : Fine timestep length <float>
- Lx : Side length of the square domain <float>
- conv_tol : The convergence criterion for iterative error <float>
- HMM_T0 : The length of the averaging window (absolute) <float>
- mu : Hyperviscosity coefficient <float>
- outFileStem : Optional stem for output filenames <str>
- f_naught : Coriolis parameters <float>
- H_naught : Mean water depth <float>
- gravity : Gravitational acceleration, g <float>
- force_gain : The gain term for stochastic forcing <float>
- epsilon : Scale separation <float>
- working_dir : The working directory <str>
- ensemble_size: The number of ensemble members for data assimilation <int>
- assim_cycle_length : The number of coarse timesteps between EnKF update steps <int>
- meas_spacing : The spacing of spatial measurement points for EnKF, such that
- data is known at 0, meas_spacing, 2*meas_spacing, ...
- N_cycles : The number of prediction/update cycles to be performed.
