FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net. Fast, secure and Free Open Source software downloads

sample.C File Reference

Sample field data with a choice of interpolation schemes, sampling options and write formats. More...

Detailed Description

Sample field data with a choice of interpolation schemes, sampling options and write formats.

Keywords:

Parameters:
setFormat: set output format, choice of

  • xmgr
  • jplot
  • gnuplot
  • raw
surfaceFormat: surface output format, choice of

  • null: suppress output
  • foamFile: separate points, faces and values file
  • dx : DX scalar or vector format
  • vtk : VTK ascii format
  • raw : x y z value format for use with e.g. gnuplot 'splot'.
  • obj : Wavefron stl. Does not contain values!
  • stl : ascii stl. Does not contain values!
interpolationScheme: interpolation scheme, choice of

  • cell : use cell-centre value; constant over cells (default)
  • cellPoint : use cell-centre and vertex values
  • cellPointFace : use cell-centre, vertex and face values.
  1. vertex values determined from neighbouring cell-centre values
  2. face values determined using the current face interpolation scheme for the field (linear, limitedLinear, etc.)
Parameters:
fields: list of fields to sample
sets: list of sets to sample, choice of

  • uniform : evenly distributed points on line
  • face : one point per face intersection
  • midPoint : one point per cell, inbetween two face intersections
  • midPointAndFace : combination of face and midPoint
  • curve : specified points, not nessecary on line, uses tracking
  • cloud : specified points, uses findCell

Option axis: how to write point coordinate. Choice of

  • x/y/z: x/y/z coordinate only
  • xyz: three columns (probably does not make sense for anything but raw)
  • distance: distance from start of sampling line (if uses line) or distance from first specified sampling point

Type specific options:

  • uniform, face, midPoint, midPointAndFace : start and end coordinate
  • uniform: extra number of sampling points
  • curve, cloud: list of coordinates
surfaces: list of surfaces to sample, choice of

  • plane : values on plane defined by point, normal.
  • patch : values on patch.
Usage
  • sample [OPTION]
Parameters:
-noZero
Do not sample the 0 directory.
-case<dir>
Path to the case directory. Defaults to the current working directory.
-parallel
Run in parallel.
-latestTime
Only sample the latest time directory.
-time<time>
Only sample the time directory.
-constant
Include the constant directory.
-help
Display help message.
-doc
Display Doxygen API documentation page for this application.
-srcDoc
Display Doxygen source documentation page for this application.

Notes Runs in parallel

Definition in file sample.C.

#include "src/OpenFOAM/global/argList/argList.H"
#include "src/OpenFOAM/db/Time/timeSelector.H"
#include "src/sampling/sampledSet/sampledSets/IOsampledSets.H"
#include "src/sampling/sampledSurface/sampledSurfaces/IOsampledSurfaces.H"
#include "src/OpenFOAM/include/addRegionOption.H"
#include "src/OpenFOAM/include/setRootCase.H"
#include "src/OpenFOAM/include/createTime.H"
#include "src/OpenFOAM/include/createNamedMesh.H"
Include dependency graph for sample.C:

Go to the source code of this file.