Skip to content

Commit e9cd2e4

Browse files
committed
updated docs to reflect changes
1 parent 84c47bd commit e9cd2e4

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/source/io_formats/settings.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -695,6 +695,7 @@ attributes/sub-elements:
695695

696696
For a "cylindrical" distribution, no parameters are specified. Instead,
697697
the ``r``, ``phi``, ``z``, and ``origin`` elements must be specified.
698+
Optionally, the ``r_dir`` and ``z_dir`` elements could be specified.
698699

699700
For a "spherical" distribution, no parameters are specified. Instead,
700701
the ``r``, ``theta``, ``phi``, and ``origin`` elements must be specified.
@@ -726,6 +727,10 @@ attributes/sub-elements:
726727
of a univariate probability distribution (see the description in
727728
:ref:`univariate`).
728729

730+
:r_dir:
731+
For "cylindrical" distributions, this element specifies the direction
732+
of the cylinder r-axis at phi=0, it defaults to (1.0, 0.0, 0.0).
733+
729734
:theta:
730735
For a "spherical" distribution, this element specifies the distribution
731736
of theta-coordinates. The necessary sub-elements/attributes are those of a
@@ -737,6 +742,10 @@ attributes/sub-elements:
737742
the distribution of phi-coordinates. The necessary
738743
sub-elements/attributes are those of a univariate probability
739744
distribution (see the description in :ref:`univariate`).
745+
746+
:phi_dir:
747+
For "cylindrical" distributions, this element specifies the direction
748+
of the cylinder phi-axis at phi=0, it defaults to (0.0, 1.0, 0.0).
740749

741750
:origin:
742751
For "cylindrical and "spherical" distributions, this element specifies

0 commit comments

Comments
 (0)