Utilities: Difference between revisions

From openpipeflow.org
Jump to navigation Jump to search
mNo edit summary
Line 13: Line 13:
The penultimate command creates <tt>utilname.out</tt>.   
The penultimate command creates <tt>utilname.out</tt>.   


It is good practice to do a <tt>'make install'</tt> to generate a [[main.info]] file to keep alongside the executable.
=== Record of parameters ===
 
* [[main.info]] is created in the <tt>install/</tt> directory at compile time by '<tt>make install</tt>'.  Keep a copy of this file along side your executables.


=== Pre/post-processing ===
=== Pre/post-processing ===
* [[main.info]] - Record of settings, created at compiletime
* [[ic.f90]] - Pre/Post-processing '''template'''.
* [[ic.f90]] - Pre/Post-processing '''template'''.
* [[describe_state.f90]] - check time/parameters; see also [[main.info]] for outputs.
* [[describe_state.f90]] - check time/parameters; see also [[main.info]] for outputs.

Revision as of 07:07, 13 December 2016

  • Utilities are used to manipulate or analyse data, either during runtime or in the post-processing phase.
  • Some of the utilities are non-specific to pipe flow, e.g. code for the GMRES algorithm.
  • Almost all modifications can/should be made via a utility, rather than altering the core code (i.e. avoid editing the contents of the program/ directory wherever possible).
  • Utilities are kept in utils/.


Building

To build, in Makefile, set UTIL = utilname (omitting the .f90 extension), then type

> make
> make install
> make util
> mv utilname.out ...

The penultimate command creates utilname.out.

Record of parameters

  • main.info is created in the install/ directory at compile time by 'make install'. Keep a copy of this file along side your executables.

Pre/post-processing

Runtime processing

Non-problem-specific codes

  • These are designed for integration with any pre-existing code.
  • File:Arnoldi.f - Krylov-subspace method for calculating eigenvalues of a matrix.
  • File:GMRESm.f90 - Krylov-subspace method for solving the linear system Ax=b for x.
  • File:NewtonHook.f90 - Newton-hookstep method for finding nonlinear solutions x for F(x)=0.