opencmp package

Subpackages

• opencmp.config_functions package
  • Submodules
  • opencmp.config_functions.base_config_functions module
  • opencmp.config_functions.boundary_conditions module
  • opencmp.config_functions.controller_functions module
  • opencmp.config_functions.expanded_config_parser module
  • opencmp.config_functions.initial_conditions module
  • opencmp.config_functions.load_config module
  • opencmp.config_functions.model_functions module
  • opencmp.config_functions.parse_arithmetic module
  • opencmp.config_functions.reference_solutions module
  • Module contents
• opencmp.controllers package
  • Submodules
  • opencmp.controllers.base_controller module
  • opencmp.controllers.controller_group module
  • opencmp.controllers.misc module
  • opencmp.controllers.pid_controller module
  • Module contents
• opencmp.diffuse_interface package
  • Submodules
  • opencmp.diffuse_interface.dim module
  • opencmp.diffuse_interface.interface module
  • opencmp.diffuse_interface.mesh_helpers module
  • opencmp.diffuse_interface.mesh_quality_metrics module
  • Module contents
• opencmp.helpers package
  • Submodules
  • opencmp.helpers.dg module
  • opencmp.helpers.error module
  • opencmp.helpers.error_analysis module
  • opencmp.helpers.io module
  • opencmp.helpers.math module
  • opencmp.helpers.mesh module
  • opencmp.helpers.misc module
  • opencmp.helpers.ngsolve_ module
  • opencmp.helpers.post_processing module
  • opencmp.helpers.saving module
  • Module contents
• opencmp.models package
  • Submodules
  • opencmp.models.base_model module
  • opencmp.models.ins module
  • opencmp.models.misc module
  • opencmp.models.multi_component_ins module
  • opencmp.models.poisson module
  • opencmp.models.stokes module
  • Module contents
• opencmp.solvers package
  • Subpackages
    • opencmp.solvers.adaptive_transient_solvers package
      • Submodules
      • opencmp.solvers.adaptive_transient_solvers.adaptive_IMEX module
      • opencmp.solvers.adaptive_transient_solvers.adaptive_three_step module
      • opencmp.solvers.adaptive_transient_solvers.adaptive_two_step module
      • opencmp.solvers.adaptive_transient_solvers.base_adaptive_transient_RK module
      • opencmp.solvers.adaptive_transient_solvers.base_adaptive_transient_multistep module
      • Module contents
  • Submodules
  • opencmp.solvers.base_solver module
  • opencmp.solvers.misc module
  • opencmp.solvers.stationary module
  • opencmp.solvers.time_integration_schemes module
  • opencmp.solvers.transient_RK module
  • opencmp.solvers.transient_multistep module
  • Module contents

Submodules

opencmp.run module

opencmp.run.run(config_file_path, config_parser=None)

Main function that runs OpenCMP.

Parameters

• config_file_path (str) – Filename of the config file to load.

• config_parser (Optional[ConfigParser, None]) – Optionally provide the ConfigParser if running tests.

Return type

None

Module contents