channelflow.org

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Channelflow documentation ======
===== Getting started =====
  * [[docs:install|Installation]]
  * [[docs:tutorial|Tutorial]]
  * {{docs:userguide.pdf|User Guide}} PDF, pretty detailed but for version 0.9.x

===== Mathematics =====
  * [[docs:math:symmetry|Symmetry]]

===== 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 ^
| [[docs:utils:addfields]]     | compute sum a_n u_n and store result to disk |
| [[docs:utils:arnoldi]]       | compute the eigenvalues and eigenfunctions of eqbs and orbits |
| [[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:couette]]       | integrate an initial condition, save results to disk |
| [[docs:utils:field2ascii]]   | convert a channelflow FlowField to a file of ASCII data |
| [[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:findorbit]]     | compute an equilibrium or periodic orbit of plane Couette |
| [[docs:utils:L2Dist]]        | compute the L2 distance between two fields |
| [[docs:utils:L2IP]]          | compute the L2 inner product |
| [[docs:utils:makebasis]]     | construct an orthonormal basis from a set of fields |
| [[docs:utils:makeheatmode]]  | construct a field that decays in time according to Laplace eqn |
| [[docs:utils:makemovie]]     | extract slices of fields in order to make a movie |
| [[docs:utils:makestokesmode]] | construct a stokes eigenfunction of laminar equilibrium |
| [[docs:utils:perturbfield]]  | add random perturbations to a given field |
| [[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:randomfield]]   | build a random initial velocity field, save to disk |
| [[docs:utils:seriesprops]]   | compute statistics on a sequence of data |
| [[docs:utils:symmetrize]]    | find the phase shift of a field that optimize a given symmetry |
| [[docs:utils:symmetryop]]    | apply a given symmetry to a field |


===== Programming  =====

^ C++ class ^ represents ^
| [[docs:classes:flowfield|FlowField]] | 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:fieldsymmetry|FieldSymmetry]] | the symmetry group of FlowFields |
channelflow.org

User Tools

Site Tools

Page Tools
