Libclasses - Revision history

Dickon Champion: /* Example object method */

2008-05-16T15:10:37Z

Example object method

Dickon Champion: /* IXFoperation_run_testclass */

2008-05-16T14:47:28Z

IXFoperation_run_testclass

Dickon Champion: /* Preprocessing class_base.f90 */

2008-05-16T13:49:58Z

Preprocessing class_base.f90

Dickon Champion: /* Example object method */

2008-05-16T09:44:15Z

Example object method

Dickon Champion: /* IXFget_testclass */

2008-05-16T09:43:19Z

IXFget_testclass

Dickon Champion: /* IXFset_testclass */

2008-05-16T09:42:52Z

IXFset_testclass

Dickon Champion at 09:41, 16 May 2008

2008-05-16T09:41:57Z

Dickon Champion: /* IXFset_testclass */

2008-05-16T09:35:56Z

IXFset_testclass

Dickon Champion: /* IXFdestroy_testclass */

2008-05-16T09:34:23Z

IXFdestroy_testclass

Dickon Champion: /* IXFdestroy_testclass */

2008-05-16T09:34:08Z

IXFdestroy_testclass

@@ Line 572: / Line 572: @@
          enddo
      endif
+<pre>
    end subroutine IXFplus_testclass</pre>

@@ Line 128: / Line 128: @@
      call IXFoperation_run(op, 'val_static', arg%val_static, status)
      call IXFoperation_run(op, 'int_static', arg%int_static, status)
-     call IXFoperation_run_ptr(op, 'val_array', arg%val_array, status)
+     call IXFoperation_run_ptr(op, 'val_array', arg%val_array, status)!this is a pointer array so the ptr suffix is used
-     call IXFoperation_run_ptr(op, 'int_array', arg%val_array, status)
+     call IXFoperation_run_ptr(op, 'int_arr', arg%int_arr, status)!this is a pointer array so the ptr suffix is used
      call IXFoperation_run(op, 'spectra', arg%spectra, status)
      call IXFoperation_run(op, 'xhist', arg%xhist, status)

@@ Line 644: / Line 644: @@
 ===Preprocessing class_base.f90===
-sometimes the standard object methods differ only very slightly, and to ensure that the code for these methods is the same in every respect, we can use the preprocessor. In the example above the <tt>IXFcreate</tt> algorithm must be defined must be defined explicitly in the module since it involves the use of individual object elements. But there are some standard subroutines which can be generalised. These subroutines are defined in <tt>class_base.f90</tt>, and are included in the method section of the module with the following statement, where two keywords are defined <tt>IXD_TYPE</tt> and <tt>IXD_SQTYPE</tt>
+sometimes the standard object methods differ only very slightly, and to ensure that the code for these methods is the same in every respect, we can use the preprocessor. In the example above the <tt>IXFcreate</tt> algorithm must be defined explicitly in the module since it involves the use of individual object elements. But there are some standard subroutines which can be generalised. These subroutines are defined in <tt>class_base.f90</tt>, and are included in the method section of the module with the following statement, where two keywords are defined <tt>IXD_TYPE</tt> and <tt>IXD_SQTYPE</tt>
 <pre>
@@ Line 653: / Line 653: @@
 these keywords are then substituted in the code contained in the include file <tt>class_base.f90</tt>. In the example below the general subroutine to allocate arrays of objects (implements the [[Special_Subroutines#IXFalloc|<tt>IXFalloc</tt>]]  interface) is defined using two separate keywords and some general code.
 The following code will only be preprocessed if both keywords are defined.

@@ Line 516: / Line 516: @@
 in this example there are no errors to calculate, and a simple addition can be performed. if there are error functions to be determined
 the standard array operations can be called for standard manipulations (plus/subtract/multiply/divide/power),
-these are defined in the [http://download.libisis.org/doxygen/html/namespaceIXMarraymanips.html IXMarraymanips] module
+these are defined in the [http://download.libisis.org/doxygen/html/namespaceIXMarraymanips.html <tt>IXMarraymanips</tt>] module
 <pre>
      if (sum(abs(shape(w1%val_array) - shape(w2%val_array)))/=0 ) then

@@ Line 375: / Line 375: @@
      if (present(nx))nx=arg%nx
 </pre>
-for variable length arrays the supplied array must be the same length as the object array. This test is made and the array filled by the built in subroutines [[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFget__real__array.html <tt>IXFget_real_array</tt>]] and [[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFget__integer__array.html <tt>IXFget_integer_array</tt>.]]
+for variable length arrays the supplied array must be the same length as the object array. This test is made and the array filled by the built in subroutines [http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFget__real__array.html <tt>IXFget_real_array</tt>] and [http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFget__integer__array.html <tt>IXFget_integer_array</tt>].
 <pre>
      call IXFget_real_array(arg%val_array,status,val_array)

@@ Line 301: / Line 301: @@
      if (present(int_static)) arg%int_static=int_static
 </pre>
-[[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFset__real__array.html <tt>IXFset_real_array</tt>]] and [[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFset__integer__array.html <tt>IXFset_integer_array</tt>]] are built in functions which reallocate the memory for the member element and fill with the new data as appropriate, they work on all pointer arrays up to 3d
+[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFset__real__array.html <tt>IXFset_real_array</tt>] and [http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFset__integer__array.html <tt>IXFset_integer_array</tt>] are built in functions which reallocate the memory for the member element and fill with the new data as appropriate, they work on all pointer arrays up to 3d
 <pre>
      call IXFset_real_array(arg%val_array,status,val_array)

@@ Line 58: / Line 58: @@
       integer(i4b)::int_static(4)=0.0
 </pre>
-variable length arrays are defined as pointers, they are '''always''' declared as NULL by default and can be allocated using the [[Special_Subroutines#IXFalloc|IXFalloc]] subroutines
+variable length arrays are defined as pointers, they are '''always''' declared as NULL by default and can be allocated using the [[Special_Subroutines#IXFalloc|<tt>IXFalloc</tt>]] subroutines
 <pre>
       real(dp), pointer :: val_array(:) => NULL()
@@ Line 72: / Line 72: @@
       character(len=short_len) :: label='x-label'
 </pre>
-variable length arrays of strings and objects cannot be defined as pointers and '''must''' be defined as allocatable, they can also be allocated using the appropriate [[Special_Subroutines#IXFalloc|IXFalloc]] subroutines
+variable length arrays of strings and objects cannot be defined as pointers and '''must''' be defined as allocatable, they can also be allocated using the appropriate [[Special_Subroutines#IXFalloc|<tt>IXFalloc</tt>]] subroutines
 <pre>
       character(len=long_len),allocatable :: cell_string(:)
@@ Line 301: / Line 301: @@
      if (present(int_static)) arg%int_static=int_static
 </pre>
-<tt>IXFset_real_array</tt> and <tt>IXFset_integer_array</tt> are built in functions which reallocate the memory for the member element and fill with the new data as appropriate, they work on all pointer arrays up to 3d
+[[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFset__real__array.html <tt>IXFset_real_array</tt>]] and [[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFset__integer__array.html <tt>IXFset_integer_array</tt>]] are built in functions which reallocate the memory for the member element and fill with the new data as appropriate, they work on all pointer arrays up to 3d
 <pre>
      call IXFset_real_array(arg%val_array,status,val_array)
@@ Line 316: / Line 316: @@
      if(present(label))arg%label=label
 </pre>
-allocatable types must follow this format, including reallocation and population of the element, either by direct assignment or in the case of an object by an [[General Subroutines#IXFcopy|<tt>IXFcopy</tt>]] call
+allocatable types must follow this format, including reallocation and population of the element, either by direct assignment or in the case of an object by an [[General Operations#IXFcopy|<tt>IXFcopy</tt>]] call
 <pre>
      if (present(cell_string))then
@@ Line 375: / Line 375: @@
      if (present(nx))nx=arg%nx
 </pre>
-for variable length arrays the supplied array must be the same length as the object array. This test is made and the array filled by the built in subroutines <tt>IXFget_real_array</tt> and <tt>IXFget_integer_array</tt>.
+for variable length arrays the supplied array must be the same length as the object array. This test is made and the array filled by the built in subroutines [[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFget__real__array.html <tt>IXFget_real_array</tt>]] and [[http://download.libisis.org/doxygen/html/interfaceIXMbase_1_1IXFget__integer__array.html <tt>IXFget_integer_array</tt>.]]
 <pre>
      call IXFget_real_array(arg%val_array,status,val_array)
@@ Line 386: / Line 386: @@
      if (present(int_static))int_static=arg%int_static
 </pre>
-supplied nested objects are filled with an appropriate IXFcopy subroutine
+supplied nested objects are filled with an appropriate [[General Operations#IXFcopy|<tt>IXFcopy</tt>]] subroutine
 <pre>
      if(present(spectra))call IXFcopy(arg%spectra,spectra,status)
@@ Line 652: / Line 652: @@
 </pre>
-these keywords are then substituted in the code contained in the include file <tt>class_base.f90</tt>. In the example below the general subroutine to allocate arrays of objects (implements the [[Special Subroutines#IXFalloc|IXFalloc]] interface) is defined using two separate keywords and some general code.
+these keywords are then substituted in the code contained in the include file <tt>class_base.f90</tt>. In the example below the general subroutine to allocate arrays of objects (implements the [[Special_Subroutines#IXFalloc|<tt>IXFalloc</tt>]]  interface) is defined using two separate keywords and some general code.

@@ Line 189: / Line 189: @@
 objects, it can also be used to set variables back to their default values.
 If one of the objects is an array of structures, then each structure will be recursively destroyed by the
-[[Special Subroutines#IXFdealloc|<tt>IXFdealloc</tt>]] function. The allocatable array of strings is a fortran type and so the [[Special Subroutines#IXFdeallocfortran|<tt>IXFdeallocfortran</tt> subroutine must be called to deallocate its memory
+[[Special Subroutines#IXFdealloc|<tt>IXFdealloc</tt>]] function. The allocatable array of strings is a fortran type and so the [[Special Subroutines#IXFdeallocfortran|<tt>IXFdeallocfortran</tt>]] subroutine must be called to deallocate its memory
 <pre>