Commit 08fd5fa3 authored by mark's avatar mark

DOC: update documentation

parent 94ae8c01
......@@ -12,7 +12,7 @@
---
2016-05-30
2016-11-02
---
......@@ -46,9 +46,9 @@ All entries are considered mandatory.
| _any_ | /constant/... | _reserved_
| _any_ | /system/... | _reserved_
| string | /openfoam/version | "plus-e40d8870f95a"
| string | /openfoam/platform | "linux64Gcc"
| string | /openfoam/endian | "little"
| int | /openfoam/label-size | 32
| string | /openfoam/precision | "double"
| int | /openfoam/scalar-size | 64
| int | /openfoam/nProcs | 4
| int | /openfoam/nRegions | 2
| string[]| /openfoam/regions | {"region0", "solid"}
......@@ -59,6 +59,16 @@ The number of regions can either be obtained directly from the
of the `/openfoam/regions` attribute. No particular sort order is
specified for the region names.
These additional attributes provide assistance when reading the data files.
These entries are advisable.
| type | name | example
|---------|-----------------------------|--------
| string | /openfoam/baseline/plus | 1609
| string | /openfoam/platform | "linux64Gcc"
### General Variables
Coordinated data for all mesh, fields and cloud information.
......@@ -133,6 +143,11 @@ Basic information that applies to mesh and field information.
| string[]| \<regionName\>/patch-names | patch names
| string[]| \<regionName\>/patch-types | patch types
The number of patches used in the mesh may be larger than the number
of patch names and types attributes since these attributes do not
include any processor patches.
#### Example
| type | name | example
......@@ -176,10 +191,12 @@ also true.
#### Localized Variables
| type | name | comment
|---------|-------------------------------------|-------------
| byte | \<regionName\>/field/p | as per OPENFOAM binary file content
| byte | \<regionName\>/field/U | as per OPENFOAM binary file content
| type | name | comment
|---------|--------------------------------------|-------------
| double | \<regionName\>/field/p | internalField - primitive field content
| byte | \<regionName\>/field/p/boundaryField | as per OPENFOAM binary file content
| double | \<regionName\>/field/U | primitive field content
| byte | \<regionName\>/field/U/boundaryField | internalField - primitive field content
| | ...
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment