SCRIMP Logo
  • How to install
    • Anaconda
    • Tests
    • Code structure
    • Documentation
  • Getting started
    • Port-Hamiltonian framework
    • Structure-preserving discretization
    • Coding within SCRIMP
  • Examples
    • The wave equation
      • wave_eq()
      • Setting
      • Port-Hamiltonian framework
      • Structure-preserving discretization
      • Simulation
      • Adding Damping to the dphs
        • wave_eq()
      • Another simulation
    • The heat equation
      • heat_eq()
      • Setting
      • Port-Hamiltonian framework
      • Structure-preserving discretization
      • Simulation
    • Another wave equation
      • wave_coenergy_eq()
      • Setting
      • Substitutions
      • Simulation
    • Heat wave coupling
      • heat_wave_eq()
      • Setting
      • Port-Hamiltonian framework
      • Structure-preserving discretization
      • Simulation
    • The shallow water equation
      • shallow_water_eq()
      • Setting
      • Port-Hamiltonian framework
      • Structure-preserving discretization
      • Simulation
  • Notebooks
    • Install jupyter
    • Run jupyter
  • Graphical User Interface
  • References
    • Articles
    • Book Chapters
    • Proceedings
  • Code documentation
    • Folders
      • scrimp.examples
        • Wave
        • Heat
        • Heat-Wave coupling
        • Shallow water
      • scrimp.utils
        • Config
        • Linear algebra
        • Mesh
      • scrimp.sandbox
    • Distributed port-Hamiltonian system
      • DPHS
        • DPHS.F
        • DPHS.IFunction()
        • DPHS.IJacobian()
        • DPHS.J
        • DPHS.add_FEM()
        • DPHS.add_brick()
        • DPHS.add_control_port()
        • DPHS.add_costate()
        • DPHS.add_parameter()
        • DPHS.add_port()
        • DPHS.add_state()
        • DPHS.allocate_memory()
        • DPHS.assemble_mass()
        • DPHS.assemble_nl_mass()
        • DPHS.assemble_nl_stiffness()
        • DPHS.assemble_rhs()
        • DPHS.assemble_stiffness()
        • DPHS.bricks
        • DPHS.buffer
        • DPHS.compute_Hamiltonian()
        • DPHS.compute_powers()
        • DPHS.controls
        • DPHS.costates
        • DPHS.disable_all_bricks()
        • DPHS.display()
        • DPHS.domain
        • DPHS.enable_all_bricks()
        • DPHS.event()
        • DPHS.exclude_algebraic_var_from_lte()
        • DPHS.export_matrices()
        • DPHS.export_to_pv()
        • DPHS.get_Hamiltonian()
        • DPHS.get_cleared_TS_options()
        • DPHS.get_quantity()
        • DPHS.get_solution()
        • DPHS.gf_model
        • DPHS.hamiltonian
        • DPHS.init_matrix()
        • DPHS.init_parameter()
        • DPHS.init_step()
        • DPHS.initial_value_set
        • DPHS.linear_mass
        • DPHS.mass
        • DPHS.monitor()
        • DPHS.nl_mass
        • DPHS.nl_stiffness
        • DPHS.plot_Hamiltonian()
        • DPHS.plot_powers()
        • DPHS.ports
        • DPHS.postevent()
        • DPHS.powers_computed
        • DPHS.rhs
        • DPHS.set_control()
        • DPHS.set_domain()
        • DPHS.set_from_vector()
        • DPHS.set_initial_value()
        • DPHS.set_linear_flags()
        • DPHS.set_time_scheme()
        • DPHS.solution
        • DPHS.solve()
        • DPHS.solve_done
        • DPHS.spy_Dirac()
        • DPHS.states
        • DPHS.stiffness
        • DPHS.stop_TS
        • DPHS.tangent_mass
        • DPHS.tangent_stiffness
        • DPHS.ts_start
    • Domain
      • Domain
        • Domain.display()
        • Domain.get_boundaries()
        • Domain.get_dim()
        • Domain.get_isSet()
        • Domain.get_mesh()
        • Domain.get_name()
        • Domain.get_subdomains()
        • Domain.set_mim_auto()
    • Hamiltonian / Term
      • Hamiltonian
        • Hamiltonian.add_term()
        • Hamiltonian.compute()
        • Hamiltonian.get_is_computed()
        • Hamiltonian.get_name()
        • Hamiltonian.get_terms()
        • Hamiltonian.set_is_computed()
        • Hamiltonian.set_name()
      • Term
        • Term.get_description()
        • Term.get_expression()
        • Term.get_mesh_id()
        • Term.get_regions()
        • Term.get_values()
        • Term.set_value()
    • Port / Parameter
      • Parameter
        • Parameter.get_description()
        • Parameter.get_expression()
        • Parameter.get_kind()
        • Parameter.get_name()
        • Parameter.get_name_port()
      • Port
        • Port.add_parameter()
        • Port.compute()
        • Port.get_algebraic()
        • Port.get_dissipative()
        • Port.get_effort()
        • Port.get_fem()
        • Port.get_flow()
        • Port.get_isSet()
        • Port.get_is_computed()
        • Port.get_kind()
        • Port.get_mesh_id()
        • Port.get_name()
        • Port.get_parameter()
        • Port.get_parameters()
        • Port.get_power()
        • Port.get_region()
        • Port.get_substituted()
        • Port.init_parameter()
        • Port.set_fem()
        • Port.set_isSet()
        • Port.set_is_computed()
        • Port.set_power()
    • State
      • State
        • State.get_costate()
        • State.get_description()
        • State.get_kind()
        • State.get_mesh_id()
        • State.get_name()
        • State.get_port()
        • State.get_region()
        • State.set_costate()
        • State.set_port()
    • Co-state
      • CoState
        • CoState.get_state()
        • CoState.get_substituted()
    • Control
      • Control_Port
        • Control_Port.get_description_control()
        • Control_Port.get_description_observation()
        • Control_Port.get_name_control()
        • Control_Port.get_name_obervation()
        • Control_Port.get_position()
    • FEM
      • FEM
        • FEM.get_dim()
        • FEM.get_fem()
        • FEM.get_isSet()
        • FEM.get_mesh()
        • FEM.get_name()
        • FEM.get_order()
        • FEM.get_type()
        • FEM.set_dim()
        • FEM.set_fem()
        • FEM.set_mesh()
    • Brick
      • Brick
        • Brick.add_id_brick_to_list()
        • Brick.disable_id_bricks()
        • Brick.enable_id_bricks()
        • Brick.get_dt()
        • Brick.get_explicit()
        • Brick.get_form()
        • Brick.get_id_bricks()
        • Brick.get_linear()
        • Brick.get_mesh_id()
        • Brick.get_name()
        • Brick.get_position()
        • Brick.get_regions()
  • ANR Impacts
  • GitHub repo
  • PDF documentation
SCRIMP
  • Search

© Copyright 2015-2024 ISAE-SUPAERO.

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