﻿CADETProcess.simulator.SimulatorBase
====================================

.. currentmodule:: CADETProcess.simulator

.. autoclass:: SimulatorBase
   :no-members:
   :no-inherited-members:
   :no-special-members:

  
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      
         SimulatorBase.__call__
         SimulatorBase.check_required_parameters
         SimulatorBase.evaluate
         SimulatorBase.get_section_times_complete
         SimulatorBase.get_solution_time
         SimulatorBase.get_solution_time_complete
         SimulatorBase.set_state_from_results
         SimulatorBase.simulate
         SimulatorBase.simulate_n_cycles
         SimulatorBase.simulate_to_stationarity
      
  

  
  
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      
         SimulatorBase.aggregated_parameters
         SimulatorBase.evaluate_stationarity
         SimulatorBase.missing_parameters
         SimulatorBase.n_cycles
         SimulatorBase.n_cycles_batch
         SimulatorBase.n_cycles_max
         SimulatorBase.n_cycles_min
         SimulatorBase.parameters
         SimulatorBase.polynomial_parameters
         SimulatorBase.raise_exception_on_max_cycles
         SimulatorBase.required_parameters
         SimulatorBase.resolution_cutoff
         SimulatorBase.sig_fig
         SimulatorBase.sized_parameters
         SimulatorBase.stationarity_evaluator
         SimulatorBase.time_resolution
  
  