From fc5b36f0db06e871aa54c42137581635135f49f4 Mon Sep 17 00:00:00 2001 From: Craig Warren Date: Wed, 14 Dec 2016 10:36:40 +0000 Subject: [PATCH] Updated notes on output file structure to indicate that current (Ix, Iy, Iz) outputs are now optional. --- docs/source/output.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/output.rst b/docs/source/output.rst index 7054592d..ae9a7761 100644 --- a/docs/source/output.rst +++ b/docs/source/output.rst @@ -32,7 +32,7 @@ The output file contains HDF5 groups for sources (``srcs``), transmission lines / rxs/ rx1/ - Name [optional] + Name Position Ex Ey @@ -40,9 +40,9 @@ The output file contains HDF5 groups for sources (``srcs``), transmission lines Hx Hy Hz - Ix - Iy - Iz + Ix [optional] + Iy [optional] + Iz [optional] rx2/ ... srcs/ @@ -66,7 +66,7 @@ The output file contains HDF5 groups for sources (``srcs``), transmission lines Within each individual ``rx`` group are the following attributes: -* ``Name`` is optional if a name for the receiver is given in the model. +* ``Name`` is the name of the receiver if specified. Otherwise 'Rx(x,y,z)', where x,y,z is the position of the receiver, is used. * ``Position`` is the x, y, z position (in metres) of the receiver in the model. Within each individual ``rx`` group can be the following datasets: @@ -77,9 +77,9 @@ Within each individual ``rx`` group can be the following datasets: * ``Hx`` is an array containing the time history (for the model time window) of the values of the x component of the magnetic field at that receiver position. * ``Hy`` is an array containing the time history (for the model time window) of the values of the y component of the magnetic field at that receiver position. * ``Hz`` is an array containing the time history (for the model time window) of the values of the z component of the magnetic field at that receiver position. -* ``Ix`` is an array containing the time history (for the model time window) of the values of the x component of current (calculated around a single cell loop) at that receiver position. -* ``Iy`` is an array containing the time history (for the model time window) of the values of the y component of current (calculated around a single cell loop) at that receiver position. -* ``Iz`` is an array containing the time history (for the model time window) of the values of the z component of current (calculated around a single cell loop) at that receiver position. +* ``Ix`` is an optional array containing the time history (for the model time window) of the values of the x component of current (calculated around a single cell loop) at that receiver position. +* ``Iy`` is an optional array containing the time history (for the model time window) of the values of the y component of current (calculated around a single cell loop) at that receiver position. +* ``Iz`` is an optional array containing the time history (for the model time window) of the values of the z component of current (calculated around a single cell loop) at that receiver position. Within each individual ``src`` group are the following attributes: