From 690ff8cabed4b8f6a94c04ded77f24b659356128 Mon Sep 17 00:00:00 2001 From: Sebastian Schunert Date: Sat, 30 Nov 2019 08:43:05 -0700 Subject: [PATCH] Additional documentation (#367) --- .../source/auxkernels/MDGranularPorosityAux.md | 16 ++++++++++++++++ .../source/auxkernels/MDGranularPropertyAux.md | 16 ++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 doc/content/source/auxkernels/MDGranularPorosityAux.md create mode 100644 doc/content/source/auxkernels/MDGranularPropertyAux.md diff --git a/doc/content/source/auxkernels/MDGranularPorosityAux.md b/doc/content/source/auxkernels/MDGranularPorosityAux.md new file mode 100644 index 00000000..dd18c307 --- /dev/null +++ b/doc/content/source/auxkernels/MDGranularPorosityAux.md @@ -0,0 +1,16 @@ +# MDGranularPorosityAux + +!syntax description /AuxKernels/MDGranularPorosityAux + +Computes porosity $\phi$ or packing fraction $1 - \phi$ and injects it into and aux variable. +The packing fraction is obtained from an `MDRunBase` object. The `MDRunBase` object needs +to operate in `granular` mode which is triggered by providing the `radius` property +in the `md_particle_properties` parameter. + +!syntax parameters /AuxKernels/MDGranularPorosityAux + +!syntax inputs /AuxKernels/MDGranularPorosityAux + +!syntax children /AuxKernels/MDGranularPorosityAux + +!bibtex bibliography diff --git a/doc/content/source/auxkernels/MDGranularPropertyAux.md b/doc/content/source/auxkernels/MDGranularPropertyAux.md new file mode 100644 index 00000000..5dc3de12 --- /dev/null +++ b/doc/content/source/auxkernels/MDGranularPropertyAux.md @@ -0,0 +1,16 @@ +# MDGranularPropertyAux + +!syntax description /AuxKernels/MDGranularPropertyAux + +Injects properties collected for MD particles from MDRunBase object user_object into auxiliary variable. +The properties are obtained from an `MDRunBase` object. The list of available properties is: +velocity in $x, y, z$ `vel_x`, `vel_y`, `vel_z`; force in $x, y, z$ `force_x`, `force_y`, `force_z`; +charge, and radius. + +!syntax parameters /AuxKernels/MDGranularPropertyAux + +!syntax inputs /AuxKernels/MDGranularPropertyAux + +!syntax children /AuxKernels/MDGranularPropertyAux + +!bibtex bibliography