Special Subroutines - Revision history

Dean Whittaker: /* other */

2008-04-02T13:44:15Z

other

2008-04-02T13:42:52Z

IXFclear_valid

2008-04-02T13:42:15Z

IXFmark_valid

2008-04-02T13:41:27Z

IXFvalid

2008-04-02T13:39:49Z

Valid Functions

2008-04-02T13:39:20Z

IXFdeallocFortran

2008-04-02T13:38:40Z

IXFreallocdimsFortran

2008-04-02T13:37:55Z

IXFallocdimsFortran

2008-04-02T13:37:01Z

IXFreallocFortran

2008-04-02T13:36:25Z

IXFallocFortran

@@ Line 421: / Line 421: @@
 ==other==
-IXFdisplay
+===IXFdisplay===
 IXFpopulate_file

← Older revision		Revision as of 13:42, 2 April 2008
Line 392:		Line 392:

	===IXFclear_valid===		===IXFclear_valid===
		+
		+
		+	his is a generic interface to the IXFclear_valid_class method.
		+
		+
		+	This subroutine is used inside a class method to clear an objects validity or mark an object as invalid. Essentially it does the opposite to IXFmark_valid. This can be called provided an IXTbase has been defined in the class. An object is marked as invalid in its IXTbase. If this subroutine is applied on an array of objects it will mark all objects in that array as invalid.
		+
		+
		+	'''F90 SYNTAX'''
		+
		+
		+	<pre>type IXTclass
		+	type(IXTbase)::base
		+	integer(i4b),pointer::array_pointer(:)=>NULL()
		+	end type IXTclass
		+	:
		+	type(IXTclass)::object
		+	type(IXTclass),allocatable::object_array(:)
		+
		+	! using generic interface
		+	call IXFclear_valid(object)
		+	call IXFclear_valid(object_array)
		+
		+	! using class specific method
		+	call IXFclear_valid_class(object)
		+	call IXFclear_valid_class(object_array)</pre>

	==other==		==other==

← Older revision		Revision as of 13:42, 2 April 2008
Line 365:		Line 365:

	===IXFmark_valid===		===IXFmark_valid===
		+
		+
		+	This is a generic interface to the IXFmark_valid_class method.
		+
		+
		+	This subroutine is used inside a class method to mark an object as valid. It does not check the objects validity. Essentially it does the opposite to IXFclear_valid. This can be called provided an IXTbase has been defined in the class. An object is marked as invalid in its IXTbase. If this subroutine is applied on an array of objects it will mark all objects in that array as valid.
		+
		+
		+	'''F90 SYNTAX'''
		+
		+	<pre>type IXTclass
		+	type(IXTbase)::base
		+	integer(i4b),pointer::array_pointer(:)=>NULL()
		+	end type IXTclass
		+	:
		+	type(IXTclass)::object
		+	type(IXTclass),allocatable::object_array(:)
		+
		+	! using generic interface
		+	call IXFmark_valid(object)
		+	call IXFmark_valid(object_array)
		+
		+	! using class specific method
		+	call IXFmark_valid_class(object)
		+	call IXFmark_valid_class(object_array)</pre>
		+
	===IXFclear_valid===		===IXFclear_valid===

@@ Line 349: / Line 349: @@
 ===IXFvalid===
 ===IXFmark_valid===
 ===IXFclear_valid===

@@ Line 332: / Line 332: @@
 ==Validity==
 ===Valid Functions===
 When an object has been properly populated with real data which is self-consistent it is marked as being 'valid'. There are routines to determine an objects validity and to mark an object as valid. These operations can only be used on objects which contain an [[IXTbase]] object.
 *IXFvalid for objects and arrays of objects
 Subroutines which can only be used within class methods of object
 *IXFmark_valid for objects and arrays of objects
 *IXFclear_valid for objects and arrays of objects
 ===IXFvalid===

← Older revision		Revision as of 13:39, 2 April 2008
Line 316:		Line 316:

	===IXFdeallocFortran===		===IXFdeallocFortran===
		+
		+
		+	'''F90 SYNTAX'''
		+
		+
		+	<pre>integer(i4b),allocatable::array(:)
		+	integer(i4b),allocatable::array2d(:,:)
		+	:
		+
		+	! deallocates array(:)
		+	call IXFdeallocFortran(array,status)
		+
		+	! deallocates array2d(:,:)
		+	call IXFallocFortran(array2d,status)</pre>

	==Validity==		==Validity==

← Older revision		Revision as of 13:38, 2 April 2008
Line 296:		Line 296:

	===IXFreallocdimsFortran===		===IXFreallocdimsFortran===
		+
		+
		+	'''F90 SYNTAX'''
		+
		+
		+	<pre>integer(i4b),allocatable::array(:)
		+	integer(i4b),allocatable::array2d(:,:)
		+	integer(i4b)::length_1,length_2
		+	logical::preserve
		+	:
		+	length_1 = 35
		+	length_2 = 45
		+
		+	! reallocates a 35 element array(:)
		+	call IXFreallocdimsFortran(array,(/ length_1 /),preserve,status)
		+
		+	! reallocates a 35 by 45 element array2d(:,:)
		+	call IXFreallocdimsFortran(array2d,(/ length_1,length_2 /),preserve,status)</pre>
		+
	===IXFdeallocFortran===		===IXFdeallocFortran===

@@ Line 276: / Line 276: @@
 ===IXFallocdimsFortran===
 ===IXFreallocdimsFortran===
 ===IXFdeallocFortran===

@@ Line 212: / Line 212: @@
 ===IXFallocFortran===
 ===IXFreallocFortran===
 ===IXFallocdimsFortran===