Logo

Get started

  • Get started
    • Installation
      • Windows
      • Linux
    • Files
    • Run your first simulation

User interface

  • Graphical user interfaced
    • Menu
      • File
      • Setup
        • Compounds editor
        • Phases editor
        • Grids specification
        • Holdups editor
        • Options
        • Calculation sequence
        • Recycle streams
      • Modules
      • Tools
        • Models manager
        • Materials database
        • Settings
      • Help
        • About
    • Tabs
      • Flowsheet
      • Simulator
      • Streams
      • Units
  • Command line interface
    • Main
    • Simulation
      • Simulation options
      • Phases
      • Compounds
      • Grids
      • Flowsheet structure
      • Unit parameters
      • Holdups
      • Export

Structure and algorithms

  • Overview
    • Flowsheet simulation of solids
    • Approaches and methods
    • Software system architecture
  • Simulation core
    • Material streams
    • Units
    • Simulator
      • Main method and approaches
      • Built-in equation solvers
  • Data storage subsystem
    • HDF5 data format
    • Data caching
  • Material database
    • DMDB file
    • Constant parameters
    • Dependent parameters
    • Interaction properties
    • Correlations
      • Correlation search
      • Correlation functions
  • Multidimentional distributed parameters of solids
    • Tree data structures
    • Treatment of dependent parameters
      • Transformation matrices
        • Application of transformation matrices
        • Application example
  • Time point management
    • Data interpolation
    • Interpolation of distributed parameters
    • Steady state units
    • Dynamic units with recycle
  • Theoretical background
    • Discretization
    • Process systems
      • Sequential-modular approach
      • Equation-oriented approach
      • Partitioning and tearing
    • Numerical methods
      • Waveform relaxation method
      • Data extrapolation
      • Convergence methods

Libraries

  • Unit library
    • Agglomerator
      • Kernels
      • Solvers
    • Crusher
      • Bond’s model
        • Average Bond Work Indices for various materials
      • Cone model
      • Const output model
    • Cyclone
    • Granulator
      • Continuous granulator
      • Batch granulator
    • Inlet flow
    • Mixer
    • Outlet flow
    • Screen
      • Plitt’s model
      • Molerus & Hoffmann model
      • Probability model
      • Teipel / Hennig model
    • Solids bunker
    • Splitter
    • Time delay
      • Simple shift
      • Norm-based
  • Solver library
    • Agglomeration solvers
      • Cell average
      • FFT
      • Fixed pivot

For developers

  • Compilation
    • Windows
      • Compilation requirements
      • Build
      • Build documentation and installers
    • Linux
      • Compilation requirements
      • Build
  • For models developers
    • Configuration of Visual Studio project template
    • Unit development
      • Add new unit to the template project
      • Configure Dyssol to work with implemented units
      • Development of steady-state units
        • Application example
      • Development of steady-state units with internal non-linear solver
        • Application example
      • Development of dynamic units
        • Application example
      • Development of dynamic units with internal DAE solver
        • Application example
      • Configure unit to work with MATLAB
    • Solver development
      • Add new solver to the template project
      • Configure Dyssol to work with implemented solvers
      • Development of agglomeration solver
      • Configure solver to work with MATLAB
  • Models API
    • Basic unit
    • Basic stream
    • Stream
    • Holdup
    • Ports manager
    • Unit port
    • Unit parameters manager
    • Unit parameters
      • Base class
      • Const
      • Const real
      • Const int
      • Const uint
      • Dependent
      • Time-dependent
      • String
      • Check box
      • Combo box
      • Compound
      • MDB compound
      • Reaction
      • List
      • List real
      • List int
      • List uint
      • Solver
    • Chemical reaction
    • Agglomeration solver
    • Base solver
    • State variables manager
    • State variable
    • Point
    • Curve
    • Plot
    • Plot manager
    • Enthalpy lookup table
    • Two-mensional matrix
    • Multidimensional matrix
    • Transformation matrix
    • PSD functions
    • Distribution functions
    • Thermodynamics
      • For material stream and holdup
      • For base unit
    • DAE Systems
      • DAE model
        • Variables
        • Tolerance
        • Virtual functions
        • Other functions
      • DAE solver
        • Model
        • Other functions
      • Application example
    • NL Systems
    • External solver
      • Basic information
      • Virtual functions
    • List of constants
      • Universal physical constants
      • Dyssol constants
Dyssol
  • »
  • Models API
  • View page source

Models API

All functions, classes, their member variables and methods, needed to develop new models are described here.

  • Basic unit
  • Basic stream
  • Stream
  • Holdup
  • Ports manager
  • Unit port
  • Unit parameters manager
  • Unit parameters
    • Base class
    • Const
    • Const real
    • Const int
    • Const uint
    • Dependent
    • Time-dependent
    • String
    • Check box
    • Combo box
    • Compound
    • MDB compound
    • Reaction
    • List
    • List real
    • List int
    • List uint
    • Solver
  • Chemical reaction
  • Agglomeration solver
  • Base solver
  • State variables manager
  • State variable
  • Point
  • Curve
  • Plot
  • Plot manager
  • Enthalpy lookup table
  • Two-mensional matrix
  • Multidimensional matrix
  • Transformation matrix
  • PSD functions
  • Distribution functions
  • Thermodynamics
  • DAE Systems
  • NL Systems
  • External solver
  • List of constants

Previous Next

© Copyright 2023, DyssolTEC GmbH.

Built with Sphinx using a theme provided by Read the Docs.