﻿CADETProcess.processModel.GeneralRateModel
==========================================

.. currentmodule:: CADETProcess.processModel

.. autoclass:: GeneralRateModel
   :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:
      
         GeneralRateModel.NTP
         GeneralRateModel.calculate_bodenstein_number
         GeneralRateModel.calculate_flow_rate_from_velocity
         GeneralRateModel.calculate_interstitial_rt
         GeneralRateModel.calculate_interstitial_velocity
         GeneralRateModel.calculate_superficial_rt
         GeneralRateModel.calculate_superficial_velocity
         GeneralRateModel.check_required_parameters
         GeneralRateModel.set_axial_dispersion_from_NTP
         GeneralRateModel.set_diameter_from_interstitial_velocity
      
  

  
  
   .. 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:
      
         GeneralRateModel.aggregated_parameters
         GeneralRateModel.axial_dispersion
         GeneralRateModel.bed_porosity
         GeneralRateModel.binding_model
         GeneralRateModel.bulk_reaction_model
         GeneralRateModel.c
         GeneralRateModel.component_system
         GeneralRateModel.cp
         GeneralRateModel.cross_section_area
         GeneralRateModel.cross_section_area_interstitial
         GeneralRateModel.diameter
         GeneralRateModel.discretization
         GeneralRateModel.discretization_schemes
         GeneralRateModel.film_diffusion
         GeneralRateModel.flow_direction
         GeneralRateModel.has_ports
         GeneralRateModel.initial_state
         GeneralRateModel.length
         GeneralRateModel.missing_parameters
         GeneralRateModel.model
         GeneralRateModel.n_bound_states
         GeneralRateModel.n_comp
         GeneralRateModel.n_ports
         GeneralRateModel.name
         GeneralRateModel.parameters
         GeneralRateModel.particle_porosity
         GeneralRateModel.particle_radius
         GeneralRateModel.particle_reaction_model
         GeneralRateModel.polynomial_parameters
         GeneralRateModel.pore_accessibility
         GeneralRateModel.pore_diffusion
         GeneralRateModel.ports
         GeneralRateModel.q
         GeneralRateModel.required_parameters
         GeneralRateModel.section_dependent_parameters
         GeneralRateModel.sized_parameters
         GeneralRateModel.supports_binding
         GeneralRateModel.supports_bulk_reaction
         GeneralRateModel.supports_particle_reaction
         GeneralRateModel.surface_diffusion
         GeneralRateModel.total_porosity
         GeneralRateModel.volume
         GeneralRateModel.volume_interstitial
         GeneralRateModel.volume_liquid
         GeneralRateModel.volume_solid
  
  