GlimSLib documentation

This repository provides a library for development and simulation of PDE-based spatial tumor growth models, as well as implementations of specific tumor growth models. It has been developed as part of the [‘Glioma Mass-Effect Simulator’ (GlimS)](http://glims.ch) project to investigate the role of tumor-induced mass-effect for tumor evolution and treatment.

Getting Started

Please see the README file for installation and configuration instructions.

Test Cases

Various application test cases for an implementation of a mechanically-coupled reaction-diffusion tumor growth model are available in test_cases().

API

The “Simulation” Module

The Simulation module consists of a base class (abstract class) that implements methods common to all problems addressed by GlimS. It also defines various abstract methods that must be implemented to instantiate this class.

  • Model-specific parameters in simulation.simulation_base._define_model_params().
  • Model-specific function space in simulation.simulation_base._setup_functionspace().
  • Model-specific governing form in simulation.simulation_base._setup_problem().
  • Model-specific parameter estimation problem in simulation.simulation_base.run_for_adjoint().

Implementations of the simulation base class represent Simulation modules for specific PDE-based models. An example is provided in simulation.simulation_tumor_growth.py().

Many functionalities of this base class rely on helper classes defined in simulation.herlpers.helper_classes.py().

Simulation Base Class (abstract)

Tumor Growth Simulation

Helper Classes

The “Visualisation” Module

The Visualisation module consists of a set of plotting functions for visualising 2D simulation results, and overlay of image data with simulation results. Some of these functions are also directly accessible from instances of the simulation classes via self.plotting.

Plotting Functions

Helpers

The “Utils” Module

The Utils module consists of helper functions for file system manipulation and (mesh) data import/export.

File System Utilities

Data IO

Indices and tables