Changes between Version 10 and Version 11 of addfield

Timestamp:

11/19/14 16:45:48 (10 years ago)

Author:

Mathieu Morlighem

Comment:

--

addfield

@@ -1 @@
-Let's use an example to illustrate how to add a field in the model. I want to add a melting rate field to the calving parameters. This melting rate is given by the user so we add the field to the GUI interface. 
+Let's use an example to illustrate how to add a field in the model. I want to add a field `melting_rate`  to the class `calving` (I want to have `md.calving.melting_rate`) that is defined by the user. 
 
-== Modify the GUI ==
+== Modify the User Interface ==
 
-Go to `src/m/classes` and modify all the classes concerned by the new field, here `calving.m` and`calvinglevermann.m` and their associated Python versions. Declare the new field, add default values (if desired), add consistency checks, display descriptions and marshall instructions. 
+Go to `src/m/classes` and modify `calving.m` and its python equivalent.
+
+ 1. Declare the new field in `properties`
+{{{
+#!m
+   melting_rate = NaN;
+}}}
+in ISSM, we use `NaN` for vectors and `0` for scalars. The default value is added with some explanation in the `setdefaultparameters` function of the class.
+
+ 2. Add a default value in  `setdefaultparameters` (Optionals, for scalars only, Literature reference is encouraged)
+ 3. Add a consistency check
+#!m
+md = checkfield(md,'fieldname','calving.meltingrate','NaN',1,'size',[md.mesh.numberofvertices 1],'>=',0);
+}}}
+which means that we want no `NaN`, the vecteur should be of size `numberofvertices` with positive values only.
+ 4. Add description in `disp`
+ 5. Add field to `marshall`
 
 == Add new Enums ==
@@ -12 +28 @@
 == Implement the new field in the model ==
 
-First, load the input: 
-
 {{{
 #!c
 Input* meltingrate_input  = NULL;
-meltingrate_input = basalelement->GetInput(CalvinglevermannMeltingrateEnum);     _assert_(meltingrate_input);
 }}}
-
-Then, start  looping on the number of gaussian points and fetch the input value at these points:
-
-{{{
-#!c
-meltingrate_input->GetInputValue(&meltingrate,gauss);
-}}}
-
-Ater that, you can do your computations using `meltingrate` for this gaussian point.
-