document the Chef Input class variables

[cwsmith]

The Chef Input variables need documentation.
https://github.com/SCOREC/core/blob/develop/phasta/phInput.h

Please donate your time. Documenting as few as two variables a day can prevent an innocent Chef user from seg-faulting.

We are using this page as a starting point for the variable descriptions: https://fluid.colorado.edu/wiki/index.php/Chef:_Mesh_Partitioning#Chef

[mrasquin]

Note that the https://fluid.colorado.edu/wiki/index.php/Chef:_Mesh_Partitioning#Chef webpage presents the input parameters associated with an old core-sim version.

[cwsmith]

To build the Doxygen html pages locally do the following:

  git clone [email protected]:SCOREC/core.git
  cd core
  mkdir buildCore
  cd buildCore

Create a script that calls cmake following the instructions here

  source cmake_script.sh
  make doc

Point your web-browser at buildCore/doc/html/index.html to view the documentation pages.

[yangf4]

we have a conflict document here: https://github.com/SCOREC/core/blob/develop/phasta/phInput.h#L119-L120

Please take a look at this. I think "simmetrixMesh" is not related to simplex mesh measure.

[cwsmith]

Thanks. I removed those lines and cleaned up the formatting a bit.

[cwsmith]

https://github.com/SCOREC/core/commit/cfbbc05941f7bee00e2ab157301f093e6f3d0f26 documents the partition control variables.