Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
TurTLE
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
TurTLE
TurTLE
Commits
540181bc
Commit
540181bc
authored
6 years ago
by
Cristian Lalescu
Browse files
Options
Downloads
Patches
Plain Diff
update documentation
parent
9bdbcc6e
Branches
Branches containing commit
Tags
Tags containing commit
1 merge request
!23
WIP: Feature/use cmake
Pipeline
#42993
failed
6 years ago
Stage: test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
documentation/_static/overview.rst
+10
-7
10 additions, 7 deletions
documentation/_static/overview.rst
with
10 additions
and
7 deletions
documentation/_static/overview.rst
+
10
−
7
View file @
540181bc
...
@@ -184,16 +184,17 @@ available, called ``bfps``, that you can execute.
...
@@ -184,16 +184,17 @@ available, called ``bfps``, that you can execute.
Just executing it will run a small test DNS on a real space grid of size
Just executing it will run a small test DNS on a real space grid of size
:math:`32 \times 32 \times 32`, in the current
:math:`32 \times 32 \times 32`, in the current
folder, with the simulation name ``test``.
folder, with the simulation name ``test``.
So, open a console, and type ``bfps
NavierStokes
``:
So, open a console, and type ``bfps
DNS NSVE
``:
.. code:: bash
.. code:: bash
# depending on how curious you are, you may have a look at the
# depending on how curious you are, you may have a look at the
# options first:
# options first:
bfps --help
bfps --help
bfps NavierStokes --help
bfps DNS --help
bfps DNS NS --help
# or you may just run it:
# or you may just run it:
bfps
NavierStokes
bfps
DNS NSVE
The simulation itself should not take more than a few seconds, since
The simulation itself should not take more than a few seconds, since
this is just a :math:`32^3` simulation run for 8 iterations.
this is just a :math:`32^3` simulation run for 8 iterations.
...
@@ -205,9 +206,9 @@ the following:
...
@@ -205,9 +206,9 @@ the following:
.. code:: python
.. code:: python
import numpy as np
import numpy as np
from bfps import
NavierStokes
from bfps import
DNS
c =
NavierStokes
(
c =
DNS
(
work_dir = '/location/of/simulation/data',
work_dir = '/location/of/simulation/data',
simname = 'simulation_name_goes_here')
simname = 'simulation_name_goes_here')
c.compute_statistics()
c.compute_statistics()
...
@@ -223,7 +224,7 @@ the following:
...
@@ -223,7 +224,7 @@ the following:
data_file['iteration'].value*c.parameters['dt'] / c.statistics['Tint'],
data_file['iteration'].value*c.parameters['dt'] / c.statistics['Tint'],
data_file['iteration'].value*c.parameters['dt'] / c.statistics['tauK']))
data_file['iteration'].value*c.parameters['dt'] / c.statistics['tauK']))
:func:`compute_statistics <bfps.
NavierStokes.NavierStokes
.compute_statistics>`
:func:`compute_statistics <bfps.
DNS.DNS
.compute_statistics>`
will read the data
will read the data
file generated by the DNS, compute a bunch of basic statistics, for
file generated by the DNS, compute a bunch of basic statistics, for
example the Taylor scale Reynolds number :math:`R_\lambda` that we're
example the Taylor scale Reynolds number :math:`R_\lambda` that we're
...
@@ -233,7 +234,7 @@ What happens is that the DNS will have generated an ``HDF5`` file
...
@@ -233,7 +234,7 @@ What happens is that the DNS will have generated an ``HDF5`` file
containing a bunch of specific datasets (spectra, moments of real space
containing a bunch of specific datasets (spectra, moments of real space
representations, etc).
representations, etc).
The function
The function
:func:`compute_statistics <bfps.
NavierStokes.NavierStokes
.compute_statistics>`
:func:`compute_statistics <bfps.
DNS.DNS
.compute_statistics>`
performs simple postprocessing that may however be expensive, therefore
performs simple postprocessing that may however be expensive, therefore
it also saves some data into a ``<simname>_postprocess.h5`` file, and
it also saves some data into a ``<simname>_postprocess.h5`` file, and
then it also performs some time averages, yielding the ``statistics``
then it also performs some time averages, yielding the ``statistics``
...
@@ -242,6 +243,8 @@ dictionary that is used in the above code.
...
@@ -242,6 +243,8 @@ dictionary that is used in the above code.
Behind the scenes
Behind the scenes
-----------------
-----------------
TODO FIXME obsolete documentation
In brief the following takes place:
In brief the following takes place:
1. An instance ``c`` of
1. An instance ``c`` of
...
...
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