[Yt-svn] commit/yt-doc: sskory: Adding some documentation about the boolean data objects.

[Bitbucket]

1 new commit in yt-doc:


https://bitbucket.org/yt_analysis/yt-doc/changeset/32a415868313/
changeset:   32a415868313
user:        sskory
date:        2011-11-04 23:32:13
summary:     Adding some documentation about the boolean data objects.
affected #:  1 file

diff -r dde3c0defa583236dcde6eaf2432ba91f7fba82a -r 32a415868313fe3aaacb91e1d82b34637a67d6e2 source/analyzing/objects.rst
--- a/source/analyzing/objects.rst
+++ b/source/analyzing/objects.rst
@@ -94,6 +94,38 @@
 
 .. include:: _obj_docstrings.inc
 
+.. _boolean_data_objects
+
+Boolean Data Objects
+--------------------
+
+A special type of data object is the *boolean* data object.
+It works only on three-dimensional objects.
+It is built by relating already existing data objects with boolean operators.
+The boolean logic may be nested using parentheses, and
+it supports the standard "AND", "OR", and "NOT" operators:
+
+* **"AND"** When two data objects are related with an "AND", the combined
+  data object is the volume of the simulation covered by both objects, and
+  not by just a single object.
+* **"OR"** When two data objects are related with an "OR", the combined
+  data object is the volume(s) of the simulation covered by either of the
+  objects.
+  For example, this may be used to combine disjoint objects into one.
+* **"NOT"** When two data objects are related with a "NOT", the combined
+  data object is the volume of the first object that the second does not
+  cover.
+  For example, this may be used to cut out part(s) of the first data object
+  utilizing the second data object.
+* **"(" or ")"** Nested logic is surrounded by parentheses. The order of
+  operations is such that the boolean logic is evaluated inside the
+  inner-most parentheses, first, then goes upwards.
+  The logic is read left-to-right at all levels (crucial for the "NOT"
+  operator).
+
+Please see the :ref:`cookbook` for some examples of how to use the boolean
+data object.
+
 .. _derived-quantities:
 
 Derived Quantities

Repository URL: https://bitbucket.org/yt_analysis/yt-doc/

--

This is a commit notification from bitbucket.org. You are receiving
this because you have the service enabled, addressing the recipient of
this email.