Changeset 5719

Timestamp:

Aug 29, 2008, 4:56:19 PM (17 years ago)

Author:

ole

Message:

Added blurb about the set_values() method.

File:

• anuga_core/documentation/user_manual/anuga_user_manual.tex (modified) (2 diffs)

anuga_core/documentation/user_manual/anuga_user_manual.tex

@@ -2127 +2127 @@
 \end{funcdesc}
 
+% FIXME (OLE): Why has this been commented out?
 %%%
 %% \begin{classdesc}{Interpolation\_function}{self,
@@ -2657 +2658 @@
   \end{funcdesc}
 
+  
+
+  \begin{funcdesc}{set\_values}{location='vertices', indices = None}
+  Module: \module{abstract\_2d\_finite\_volumes.quantity}
+
+  Assign values to a quantity object.
+  This method works the same way as \code{set\_quantity} except that it doesn't take
+  a quantity name as the first argument. The reason to use \code{set\_values} is for
+  example to assign values to a new quantity that has been created but which is 
+  not part of the domain's predefined quantities.
+
+  The method \code{set\_values} is always called by \code{set\_quantity} 
+  behind the scenes. 
+  
+  \end{funcdesc}
+  
+  
 
   \begin{funcdesc}{get\_integral}{}