User Tools

Site Tools


docs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
docs [2009/02/14 16:35]
gibson
docs [2015/06/15 09:22] (current)
gibson [Getting started]
Line 2: Line 2:
 ===== 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:​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]]
 +  * [[docs:​math:​baseflow|Base flow and fluctuation]]
 +  * [[docs:​math:​newton_krylov_hookstep|The Newton-Krylov-hookstep algorithm]] for finding equilibria and periodic orbits
  
 ===== Utilities ===== ===== Utilities =====
Line 21: 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 33: 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 39: Line 48:
 | [[docs:​utils:​symmetrize]] ​   | find the phase shift of a field that optimize a given symmetry | | [[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 | | [[docs:​utils:​symmetryop]] ​   | apply a given symmetry to a field |
- 
  
 ===== Programming ​ ===== ===== Programming ​ =====
  
-^ C++ class ^ represents ^ +Some [[docs:​c++basics|C++ basics]]. 
-| [[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 |+^ C++ class ^header file^represents ^ 
 +| [[docs:​classes:​flowfield|FlowField]] ​| {{:​librarycodes:​flowfield.h}} ​| spectral expansions of scalar, vector, tensor fields (e.g. velocity) | 
 +| [[docs:​classes:​dns|DNS]] ​            | {{:​librarycodes:​dns.h}} ​| Direct Numerical Simulation algorithms (i.e. time-stepping scheme) ​   | 
 +| [[docs:​classes:​fieldsymmetry|FieldSymmetry]] ​| {{:​librarycodes:​symmetry.h}} ​| the symmetry group of FlowFields |
docs.1234658132.txt.gz · Last modified: 2009/02/14 16:35 by gibson