docs
====== Differences ====== This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
docs [2009/02/13 07:38] gibson |
docs [2015/06/15 09:22] (current) gibson [Getting started] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Channelflow documentation ====== | ====== Channelflow documentation ====== | ||
| - | |||
| ===== Getting started ===== | ===== Getting started ===== | ||
| * [[docs:install|Installation]] | * [[docs:install|Installation]] | ||
| + | * Tutorials | ||
| + | * [[docs:tutorials:integration|Time integration of a plane Couette or channel flow]] | ||
| + | * [[docs:tutorials:findsoln|Finding an equilibrium solution or periodic orbit]] | ||
| * [[docs:tutorial|Tutorial]] | * [[docs:tutorial|Tutorial]] | ||
| + | * {{docs:chflowguide.pdf|User Guide}} (detailed but outdated, for version 0.9.x) | ||
| + | * [[docs:trillian|Tips for installation and usage on UNH's Cray XE6m-200]] | ||
| ===== Mathematics ===== | ===== Mathematics ===== | ||
| * [[docs:math:symmetry|Symmetry]] | * [[docs:math:symmetry|Symmetry]] | ||
| - | ===== Channelflow command-line utilities ===== | + | * [[docs:math:baseflow|Base flow and fluctuation]] |
| + | * [[docs:math:newton_krylov_hookstep|The Newton-Krylov-hookstep algorithm]] for finding equilibria and periodic orbits | ||
| + | |||
| + | ===== Utilities ===== | ||
| + | |||
| + | Channelflow includes a number of predefined command-line utilities that perform common calculations | ||
| + | for research in the dynamics of turbulence. Most utilities read a velocity field from disk, operate | ||
| + | on it according to command-line options, and save the resulting fields or data to disk. See | ||
| + | [[docs:utils:options|utility options]] for an overview of the option/argument syntax. | ||
| + | |||
| ^ program name ^ purpose ^ | ^ program name ^ purpose ^ | ||
| | [[docs:utils:addfields]] | compute sum a_n u_n and store result to disk | | | [[docs:utils:addfields]] | compute sum a_n u_n and store result to disk | | ||
| Line 13: | Line 26: | ||
| | [[docs:utils:ascii2field]] | convert a file of ASCII data to a channelflow FlowField | | | [[docs:utils:ascii2field]] | convert a file of ASCII data to a channelflow FlowField | | ||
| | [[docs:utils:changegrid]] | change the discretization or box size of a field | | | [[docs:utils:changegrid]] | change the discretization or box size of a field | | ||
| + | | [[docs:utils:continuefields]] | quadratic continuation of fields against arbitrary parameter | | ||
| + | | [[docs:utils:continuesoln]] | quadratic continuation of solutions against Re, Lx or Lz | | ||
| | [[docs:utils:couette]] | integrate an initial condition, save results to disk | | | [[docs:utils:couette]] | integrate an initial condition, save results to disk | | ||
| - | | [[docs:utils:field2ascii]] | convert a channelflow FlowField to a file of ASCII data | | + | | [[docs:utils:field2ascii]] | convert a binary FlowField datafile to a file of ASCII data | |
| + | | [[docs:utils:field2hdf5]] | convert a binary FlowField datafile to a HDF5 datafile | | ||
| | [[docs:utils:fieldplots]] | extract a number of 2D slices of the 3D field, good for plots | | | [[docs:utils:fieldplots]] | extract a number of 2D slices of the 3D field, good for plots | | ||
| | [[docs:utils:fieldprops]] | print out norms, symmetries, geometrical data of a stored field | | | [[docs:utils:fieldprops]] | print out norms, symmetries, geometrical data of a stored field | | ||
| - | | [[docs:utils:findorbit]] | compute an equilibrium or periodic orbit of plane Couette | | + | | [[docs:utils:findsoln]] | compute an equilibrium, traveling wave, or periodic orbit of plane Couette | |
| | [[docs:utils:L2Dist]] | compute the L2 distance between two fields | | | [[docs:utils:L2Dist]] | compute the L2 distance between two fields | | ||
| | [[docs:utils:L2IP]] | compute the L2 inner product | | | [[docs:utils:L2IP]] | compute the L2 inner product | | ||
| Line 25: | Line 41: | ||
| | [[docs:utils:makestokesmode]] | construct a stokes eigenfunction of laminar equilibrium | | | [[docs:utils:makestokesmode]] | construct a stokes eigenfunction of laminar equilibrium | | ||
| | [[docs:utils:perturbfield]] | add random perturbations to a given field | | | [[docs:utils:perturbfield]] | add random perturbations to a given field | | ||
| + | | [[docs:utils:poincare]] | compute a poincare section of plane couette or channel flow dynamics | | ||
| | [[docs:utils:projectfields]] | project a set of fields onto a given basis | | | [[docs:utils:projectfields]] | project a set of fields onto a given basis | | ||
| | [[docs:utils:projectseries]] | project a sequence of fields onto a given basis | | | [[docs:utils:projectseries]] | project a sequence of fields onto a given basis | | ||
| Line 32: | Line 49: | ||
| | [[docs:utils:symmetryop]] | apply a given symmetry to a field | | | [[docs:utils:symmetryop]] | apply a given symmetry to a field | | ||
| - | Most utilities read a velocity field from disk, operate on it according to command-line options, and | + | ===== Programming ===== |
| - | save the resulting fields or data to disk. See [[docs:utils:options|utility options]] for an overview | + | |
| - | of the option/argument syntax. | + | Some [[docs:c++basics|C++ basics]]. |
| - | ===== Programming with Channelflow ===== | ||
| - | ^ C++ class ^ represents ^ | + | ^ C++ class ^header file^represents ^ |
| - | | [[docs:classes:flowfield|FlowField]] | spectral expansions of scalar, vector, tensor fields (e.g. velocity) | | + | | [[docs:classes:flowfield|FlowField]] | {{:librarycodes:flowfield.h}} | spectral expansions of scalar, vector, tensor fields (e.g. velocity) | |
| - | | [[docs:classes:dns|DNS]] | Direct Numerical Simulation algorithms (i.e. time-stepping scheme) | | + | | [[docs:classes:dns|DNS]] | {{:librarycodes:dns.h}} | Direct Numerical Simulation algorithms (i.e. time-stepping scheme) | |
| - | | [[docs:classes:fieldsymmetry|FieldSymmetry]] | the symmetry group of FlowFields | | + | | [[docs:classes:fieldsymmetry|FieldSymmetry]] | {{:librarycodes:symmetry.h}} | the symmetry group of FlowFields | |
docs.1234539531.txt.gz · Last modified: 2009/02/13 07:38 by gibson
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
