Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
psimpy
Manage
Activity
Members
Labels
Plan
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
GitLab community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
mbd
psimpy
Commits
8f0a2295
Commit
8f0a2295
authored
2 years ago
by
Hu Zhao
Browse files
Options
Downloads
Patches
Plain Diff
docs: add description of simulator
parent
7b3282b0
Branches
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/source/simulator/index.rst
+14
-6
14 additions, 6 deletions
docs/source/simulator/index.rst
with
14 additions
and
6 deletions
docs/source/simulator/index.rst
+
14
−
6
View file @
8f0a2295
...
...
@@ -2,16 +2,24 @@
Simulator
*********
This module hosts functionality for running simulators, as well as some
simulators used in the landslide community.
A `simulator` essentially represents a mapping from an input space :math:`\mathcal{X}`
to an output space :math:`\mathcal{Y}`. More specifically, given a simulator
:math:`\mathbf{y}=\mathbf{f}(\mathbf{x})`, it maps a :math:`p`-dimensional input
:math:`\mathbf{x} \in \mathcal{X} \subset{\mathbb{R}^p}` to a :math:`k`-dimensional output
:math:`\mathbf{y} \in \mathcal{Y} \subset{\mathbb{R}^k}`.
The mapping :math:`\mathbf{f}` can vary from simple linear equations which can be analytically
solved to complex partial differential equations which requires numerical schemes such as
finite element methods.
Currently implemented classes are:
This module hosts functionality for running simulators, as well as some
simulators used to model landslide run-out processes. Currently implemented
classes are:
* :class:`.RunSimulator`:
* :class:`.RunSimulator`:
Serial and parallel execution for simulators defined by the user.
* :class:`.MassPointModel`:
* :class:`.MassPointModel`:
Mass point model for landslide run-out simulation.
* :class:`.Ravaflow24Mixture`:
* :class:`.Ravaflow24Mixture`:
Voellmy-type shallow flow model for landslide run-out simulation.
.. toctree::
:maxdepth: 1
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment