Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/Makefile.svn-base

+# Fortran compiler
+FF = gfortran
+
+# general compiler flags
+FLAGS =
+
+# compiler flags for linear algebra
+LINALG = -llapack -lblas
+
+# list of required object files
+OBJECTS = fruit_util.o fruit.o \
+		system_constants.o \
+		log_messages.o log_message_control.o \
+		vector_def.o dense_matrix_def.o band_sym_matrix_def.o \
+        linear_solver.o \
+        material_data.o field_data.o boundary_data.o \
+		pde_solver_constants.o \
+		constitutive.o kinematic.o \
+		material_model.o \
+		interpolation.o integration.o \
+		pde_solver_control.o \
+		log_messages_test.o log_message_control_test.o \
+		vector_test.o dense_matrix_test.o band_sym_matrix_test.o \
+        linear_solver_test.o \
+		material_data_test.o field_data_test.o boundary_data_test.o \
+		constitutive_test.o \
+		pde_solver_control_test.o \
+		test_driver.o
+
+all: test_driver check
+
+check:
+	./test_driver.a
+	
+doc:
+	doxygen doc-dynsws
+
+test_driver: $(OBJECTS)
+	$(FF) -o test_driver.a $(OBJECTS) $(LINALG) $(FLAGS)
+
+		
+		
+fruit_util.o: fruit_util.f90
+	$(FF) -c fruit_util.f90 $(FLAGS)
+	
+fruit.o: fruit.f90
+	$(FF) -c fruit.f90 $(FLAGS)
+	
+	
+	
+test_driver.o: test_driver.f90
+	$(FF) -c test_driver.f90 $(LINALG) $(FLAGS)
+	
+	
+	
+band_sym_matrix_def.o: band_sym_matrix_def.f90
+	$(FF) -c band_sym_matrix_def.f90 $(FLAGS)
+	
+band_sym_matrix_test.o: band_sym_matrix_test.f90
+	$(FF) -c band_sym_matrix_test.f90 $(FLAGS)
+	
+	
+	
+boundary_data.o: boundary_data.f90
+	$(FF) -c boundary_data.f90 $(FLAGS)
+	
+boundary_data_test.o: boundary_data_test.f90
+	$(FF) -c boundary_data_test.f90 $(FLAGS)
+	
+
+	
+constitutive.o: constitutive.f90
+	$(FF) -c constitutive.f90 $(FLAGS)
+	
+constitutive_test.o: constitutive_test.f90
+	$(FF) -c constitutive_test.f90 $(FLAGS)
+	
+	
+	
+dense_matrix_def.o: dense_matrix_def.f90
+	$(FF) -c dense_matrix_def.f90 $(FLAGS)
+	
+dense_matrix_test.o: dense_matrix_test.f90
+	$(FF) -c dense_matrix_test.f90 $(FLAGS)
+	
+	
+	
+field_data.o: field_data.f90
+	$(FF) -c field_data.f90 $(FLAGS)
+	
+field_data_test.o: field_data_test.f90
+	$(FF) -c field_data_test.f90 $(FLAGS)
+	
+	
+	
+integration.o: integration.f90
+	$(FF) -c integration.f90 $(FLAGS)
+	
+	
+	
+interpolation.o: interpolation.f90
+	$(FF) -c interpolation.f90 $(FLAGS)
+	
+	
+	
+kinematic.o: kinematic.f90
+	$(FF) -c kinematic.f90 $(FLAGS)
+	
+	
+    
+linear_solver.o: linear_solver.f90
+	$(FF) -c linear_solver.f90 $(LINALG) $(FLAGS)
+	
+linear_solver_test.o: linear_solver_test.f90
+	$(FF) -c linear_solver_test.f90 $(LINALG) $(FLAGS)
+	
+    
+	
+log_message_control.o: log_message_control.f90
+	$(FF) -c log_message_control.f90 $(FLAGS)
+	
+log_message_control_test.o: log_message_control_test.f90
+	$(FF) -c log_message_control_test.f90 $(FLAGS)
+	
+	
+	
+log_messages.o: log_messages.f90
+	$(FF) -c log_messages.f90 $(FLAGS)
+	
+log_messages_test.o: log_messages_test.f90
+	$(FF) -c log_messages_test.f90 $(FLAGS)
+	
+	
+	
+material_model.o: material_model.f90
+	$(FF) -c material_model.f90 $(FLAGS)
+	
+	
+	
+material_data.o: material_data.f90
+	$(FF) -c material_data.f90 $(FLAGS)
+	
+material_data_test.o: material_data_test.f90
+	$(FF) -c material_data_test.f90 $(FLAGS)
+	
+	
+	
+pde_solver_constants.o: pde_solver_constants.f90
+	$(FF) -c pde_solver_constants.f90 $(FLAGS)
+	
+	
+	
+pde_solver_control.o: pde_solver_control.f90
+	$(FF) -c pde_solver_control.f90 $(FLAGS)
+	
+pde_solver_control_test.o: pde_solver_control_test.f90
+	$(FF) -c pde_solver_control_test.f90 $(FLAGS)
+	
+	
+	
+system_constants.o: system_constants.f90
+	$(FF) -c system_constants.f90 $(FLAGS)
+	
+	
+	
+vector_def.o: vector_def.f90
+	$(FF) -c vector_def.f90 $(FLAGS)
+	
+vector_test.o: vector_test.f90
+	$(FF) -c vector_test.f90 $(FLAGS)
+	
+
+
+clean:
+	rm -rf *.o
+	
+clean_test:
+	rm -rf test_driver.o
+	
+clean_boundary_data: 	clean_test \
+						clean_integration clean_interpolation \
+						clean_pde_solver_control
+	rm -rf boundary_data.o boundary_data_test.o
+	
+clean_bsm: 	clean_test \
+			clean_pde_solver_control
+	rm -rf band_sym_matrix_def.o band_sym_matrix_test.o
+	
+clean_constitutive: clean_test \
+					clean_integration clean_material_model
+	rm -rf constitutive.o constitutive_test.o
+	
+clean_dm: 	clean_test \
+			clean_bsm clean_constitutive clean_integration \
+			clean_interpolation clean_kinematic clean_material_model \
+			clean_pde_solver_control
+	rm -rf dense_matrix_def.o dense_matrix_test.o
+	
+clean_field_data: 	clean_test \
+					clean_integration clean_interpolation \
+					clean_kinematic clean_boundary_data \
+					clean_pde_solver_control
+	rm -rf field_data.o field_data_test.o
+	
+clean_integration: 	clean_test \
+					clean_pde_solver_control
+	rm -rf integration.o
+	
+clean_interpolation: 	clean_test \
+						clean_integration
+	rm -rf interpolation.o
+	
+clean_kinematic: 	clean_test \
+					clean_integration
+	rm -rf kinematic.o
+	
+clean_linear_solver: clean_test
+	rm -rf linear_solver.o linear_solver_test.o
+	
+clean_log: 	clean_test \
+			clean_bsm clean_dm clean_vec \
+			clean_material_data clean_field_data \
+			clean_constitutive \
+			clean_pde_solver_control
+	rm -rf log_message_control.o log_message_control_test.o
+	
+clean_material_data: 	clean_test \
+						clean_integration clean_field_data \
+						clean_pde_solver_control
+	rm -rf material_data.o material_data_test.o
+	
+clean_material_model: clean_test
+	rm -rf material_model.o
+	
+clean_msg: 	clean_test \
+			clean_bsm clean_dm clean_log clean_vec \
+			clean_material_data clean_field_data \
+			clean_constitutive \
+			clean_pde_solver_control
+	rm -rf log_messages.o log_messages_test.o
+	
+clean_pde_solver_constants: clean_test \
+							clean_integration \
+							clean_pde_solver_control
+	rm -rf pde_solver_constants.o
+	
+clean_pde_solver_control: 	clean_test
+	rm -rf pde_solver_control.o pde_solver_control_test.o
+	
+clean_system_constants: clean_test \
+						clean_log clean_msg \
+						clean_constitutive clean_kinematic \
+						clean_interpolation \
+						clean_pde_solver_constants \
+						clean_material_data clean_field_data \
+						clean_pde_solver_control
+	rm -rf system_constants.o
+	
+clean_vec: 	clean_test \
+			clean_bsm clean_dm clean_integration \
+			clean_material_model \
+			clean_pde_solver_control
+	rm -rf vector_def.o vector_test.o

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/README.txt.svn-base

+* ------------------------------------------------------------------------
+*
+* DynSWS 1.0
+* Dynamic Model of Soil-Water-Structure Interaction
+*
+* Contact:
+* Brandon Karchewski
+* c/o Dept. of Civil Engineering (JHE-301)
+* McMaster University
+* 1280 Main Street West
+* Hamilton, Ontario, Canada
+* L8S 4L7
+* T: (905) 529-6569
+* E: karcheba@mcmaster.ca
+*
+* ------------------------------------------------------------------------
+
+
+------------------
+REVISION HISTORY:
+------------------
+
+    [26 March 2012]
+        -Initialized this README file
+    
+    [29 March 2012]
+        -Added build instructions for prerequisite libraries
+        -Modified build instructions for DynSWS
+    
+    [1 April 2012]
+        -Added descriptions of new modules
+        
+    [2 April 2012]
+        -Added descriptions of new modules
+    
+    [3 April 2012]
+        -Added descriptions of new modules
+        -Modified build instructions for clarity
+        
+    [5 April 2012]
+        -Added documentation instructions
+        
+    [6 April 2012]
+        -Added descriptions of new modules
+        
+        
+        
+------------------------
+BACKGROUND INFORMATION:
+------------------------
+
+This file relates to the program DynSWS. New users/developers should see
+the following documents to become acquainted with the project:
+
+Software Requirements Specification
+DynSWS-SRS-1.0.pdf
+
+Module Guide:
+DynSWS-MG-1.0.pdf
+
+Module Interface Specification:
+DynSWS-MIS-1.0.pdf
+
+SRS, MG, and MIS for PDE Solver Module:
+DynSWS-PDE-1.0.pdf
+
+
+
+-----------------------
+PROJECT PREREQUISITES:
+-----------------------
+
+The following netlib linear algebra packages should be available on
+the build path to be linked against:
+
+    BLAS (Basic Linear Algebra Subprograms)
+        http://www.netlib.org/blas/
+
+    LAPACK (Linear Algebra PACKage)
+        http://www.netlib.org/lapack/
+
+Both can be obtained by visiting the LAPACK project website and
+downloading the latest version of LAPACK. As of this moment it
+is LAPACK 3.4.0. Here is a minimal instruction set for building
+the package (assuming the compiler is gfortran):
+
+    1. Extract downloaded package to desired directory.
+    2. cd to the root directory of the LAPACK package.
+    3. Delete the .example extension from make.inc.example.
+        -Note: The user may want to look inside this file to make
+                sure the configuration is appropriate for their
+                system.
+    4. cd BLAS/SRC
+    5. make
+    6. cd ../../
+    7. make
+
+This should build and test the reference BLAS and the LAPACK
+package. The user may want to use their own machine-tuned version,
+but that will be left at their discretion. At any rate, the
+instructions above should leave the user with a generic BLAS and
+LAPACK build. The libraries generated will have the filenames:
+    
+    librefblas.a
+    libtmglib.a
+    liblapack.a
+    
+The user should copy these into a folder that is on the build
+path for their compiler (generally a folder called 'lib' within
+the file system of the shell program or the compiler suite).
+Generally, the user should also change the name of 'librefblas.a'
+to 'libblas.a' so that the compiler can find it with the -lblas
+switch.
+       
+       
+       
+-----------------------------
+DOCUMENTATION PREREQUISITES:
+-----------------------------
+
+To build the documentation from the source code, the doxygen system is
+required. This can be obtained from:
+    
+    http://www.stack.nl/~dimitri/doxygen/
+    
+The user should follow the installation instructions associated with their
+system. Note that this item is not required to build the actual program.
+
+
+
+------------------
+PROJECT CONTENTS:
+------------------
+
+    README.txt
+        Contains general information about project and build instructions
+
+    Makefile
+        Makefile for building the program including unit tests
+
+    fruit.f90
+    fruit_util.f90
+        Unit testing framework (FRUIT) for Fortran
+        See http://sourceforge.net/apps/mediawiki/fortranxunit/index.php?title=Main_Page
+            http://sourceforge.net/projects/fortranxunit/
+            http://fortranxunit.sourceforge.net/
+
+    band_sym_matrix_def.f90
+    band_sym_matrix_test.f90
+        Banded Symmetric Matrix ADT and associated unit tests
+        
+    boundary_data.f90
+    boundary_data_test.f90
+        Boundary Data Module and associated tests
+        
+    constitutive.f90
+        Constitutive Matrix module
+
+    dense_matrix_def.f90
+    dense_matrix_test.f90
+        Dense Matrix ADT and associated unit tests
+        
+    field_data.f90
+    field_data_test.f90
+        Field Data Module and associated tests
+        
+    integration.f90
+        Body Element Integration and Traction Element Integration modules
+        
+    interpolation.f90
+        Body Element Interpolation and Traction Element Interpolation modules
+        
+    kinematic.f90
+        Kinematic Matrix Module
+
+    log_message_control.f90
+    log_message_control_test.f90
+        Log Message Control module and associated unit tests
+
+    log_messages.f90
+    log_messages_test.f90
+        Log Messages Module and associated unit tests
+        
+    material_data.f90
+    material_data_test.f90
+        Material Property Data module and associated unit tests
+        
+    pde_solver_control.f90
+    pde_solver_control_test.f90
+        PDE Solver Control module and associated unit tests
+
+    system_constants.f90
+        System Constants Module
+
+    test_driver.f90
+        Driver program for unit tests
+
+    vector_def.f90
+    vector_test.f90
+        Vector ADT and associated unit tests
+        
+        
+        
+--------------------
+BUILD INSTRUCTIONS:
+--------------------
+
+To build and run the test suite:
+    1. Open shell
+    2. cd to directory of DynSWS
+    3. Open Makefile and set FF to the name of your Fortran compiler
+            (the default is gfortran)
+    4. make
+    
+This will build the program and run the unit test suite. The results of
+the unit tests will be printed to the console. The test suite will also
+generate testName.log and test_straight_coarse.log files. Assuming that
+the unit tests all pass, the contents are not important as these are just
+by-products of the exception checking tests.
+
+
+
+--------------------
+BUILD DOCUMENTATION:
+--------------------
+
+To build documentation from the source code:
+    1. Open shell
+    2. cd to directory of DynSWS
+    3. make doc
+    
+Note that this generates both html and latex format documentation. The
+html version will work out of the box and is contained in the directory
+<dir of DynSWS>/doc/html. The latex documentation may be build as follows
+(assuming the shell is still open and the current directory is that of
+DynSWS):
+
+    1. cd doc/latex
+    2. make
+    
+Note that the latex version has issues at this point in time. The author's
+recommended version of the documentation is the html version.

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/band_sym_matrix_def.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module defining Banded Symmetric Matrix data type
+! ------------------------------------------------------------------------
+MODULE band_sym_matrix_def
+USE log_message_control   !> Printing log/error messages
+USE log_messages          !> Log/error codes
+USE vector_def            !> Vector data type
+USE dense_matrix_def      !> Dense Matrix data type
+
+IMPLICIT NONE
+PRIVATE
+
+
+
+! ************************************************************************
+! EXPORTS
+! ************************************************************************
+
+
+!> Exported data types
+PUBLIC :: bandSymMatrixT
+
+!> Exported interfaces
+PUBLIC :: bsm_init, bsm_clean, &
+          bsm_numRows, bsm_halfBW, &
+          bsm_get, bsm_set, &
+          bsm_setDecomp, bsm_isDecomposed, &
+          bsm_add, OPERATOR (+), bsm_mappedAdd, &
+          bsm_scalMul, OPERATOR (*), bsm_vecMul
+
+
+
+! ************************************************************************
+! LOCAL CONSTANTS
+! ************************************************************************
+
+!> Sender code for Banded SYmmetric MATrix module
+INTEGER, PARAMETER :: sdr = BSYMAT
+
+
+
+! ************************************************************************
+! DATA TYPES
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Banded Symmetric Matrix ADT structure
+!!
+!!  \param dat            Array to store packed (banded symmetric) data
+!!  \param decomp         Array to store packed Cholesky decomposition
+!!  \param is_decomposed  Switch indicating whether decomposition is present
+! ------------------------------------------------------------------------
+TYPE bandSymMatrixT
+  DOUBLE PRECISION, ALLOCATABLE :: dat(:,:)
+  DOUBLE PRECISION, ALLOCATABLE :: decomp(:,:)
+  LOGICAL :: is_decomposed
+END TYPE bandSymMatrixT
+
+
+
+! ************************************************************************
+! INTERFACES
+! ************************************************************************
+
+
+!>  \brief Interface to constructor
+INTERFACE bsm_init
+  MODULE PROCEDURE bsm_init_
+  MODULE PROCEDURE bsm_init_exc_
+END INTERFACE bsm_init
+
+!>  \brief Interface to destructor
+INTERFACE bsm_clean
+  MODULE PROCEDURE bsm_clean_
+END INTERFACE bsm_clean
+
+!>  \brief Interface to number of rows
+INTERFACE bsm_numRows
+  MODULE PROCEDURE bsm_num_rows_
+END INTERFACE bsm_numRows
+
+!>  \brief Interface to half bandwidth
+INTERFACE bsm_halfBW
+  MODULE PROCEDURE bsm_half_bw_
+END INTERFACE bsm_halfBW
+
+!>  \brief Interface to getter for individual entries in matrix
+INTERFACE bsm_get
+  MODULE PROCEDURE bsm_get_
+  MODULE PROCEDURE bsm_get_exc_
+END INTERFACE bsm_get
+
+!>  \brief Interface to setter for individual entries in matrix
+INTERFACE bsm_set
+  MODULE PROCEDURE bsm_set_
+  MODULE PROCEDURE bsm_set_exc_
+END INTERFACE bsm_set
+
+!>  \brief Interface to setter for Cholesky decomposition
+INTERFACE bsm_setDecomp
+  MODULE PROCEDURE bsm_set_decomp_
+  MODULE PROCEDURE bsm_set_decomp_exc_
+END INTERFACE bsm_setDecomp
+
+!>  \brief Interface to check if decomposition exists
+INTERFACE bsm_isDecomposed
+  MODULE PROCEDURE bsm_is_decomposed_
+END INTERFACE bsm_isDecomposed
+
+!>  \brief Interface for addition of two bandSymMatrixT
+INTERFACE bsm_add
+  MODULE PROCEDURE bsm_add_
+  MODULE PROCEDURE bsm_add_exc_
+END INTERFACE bsm_add
+
+!>  \brief Operator overload for addition
+INTERFACE OPERATOR (+)
+  MODULE PROCEDURE bsm_add_
+END INTERFACE
+
+!>  \brief Interface for adding a matrixT to a bandSymMatrixT in place with mapping indices
+INTERFACE bsm_mappedAdd
+  MODULE PROCEDURE bsm_mapped_add_
+  MODULE PROCEDURE bsm_mapped_add_exc_
+END INTERFACE bsm_mappedAdd
+
+!>  \brief Interface for scalar multiplication
+INTERFACE bsm_scalMul
+  MODULE PROCEDURE bsm_scal_mul_mat_scal_
+END INTERFACE bsm_scalMul
+
+!>  \brief Interface for matrix-vector multiplication
+INTERFACE bsm_vecMul
+  MODULE PROCEDURE bsm_vec_mul_
+  MODULE PROCEDURE bsm_vec_mul_exc_
+END INTERFACE bsm_vecMul
+
+!>  \brief Operator overload for multiplication (includes scalar and vector multiplication)
+INTERFACE OPERATOR (*)
+  MODULE PROCEDURE bsm_scal_mul_mat_scal_
+  MODULE PROCEDURE bsm_scal_mul_scal_mat_
+  MODULE PROCEDURE bsm_vec_mul_
+END INTERFACE
+
+
+
+CONTAINS
+
+
+
+! ************************************************************************
+! ACCESS PROGRAMS
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for bandSymMatrixT (non-exception checking)
+!!
+!!  \param self Reference to the banded symmetric matrix to be initialized
+!!  \param hbw  Half bandwidth of the matrix
+!!  \param n    Number of rows/columns in the matrix
+!!
+!!  This routine initializes the bandSymMatrixT object referenced by self.
+!!  The data structures contained in self are allocated and initial values
+!!  are set to zero.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_init_ (self, hbw,n)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+  INTEGER, INTENT(IN) :: hbw,n
+  INTEGER :: i,j    !> loop variables
+
+  !> only reallocate if new dimensions do not match existing dimensions
+  IF (bsm_halfBW(self).NE.hbw .OR. bsm_numRows(self).NE.n) THEN
+
+    !> reset object if it was previously initialized
+    CALL bsm_clean(self)
+
+    !> allocate new data structures
+    ALLOCATE(self%dat(hbw,n))
+    ALLOCATE(self%decomp(hbw,n))
+
+  END IF
+
+  !> ensure data is initialized to zero
+  DO j = 1,n
+    DO i = 1,hbw
+      self%dat(i,j) = 0.d0
+      self%decomp(i,j) = 0.d0
+    END DO
+  END DO
+
+  !> reset boolean for decomposition
+  self%is_decomposed = .FALSE.
+
+END SUBROUTINE bsm_init_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for bandSymMatrixT (exception checking)
+!!
+!!  \param self Reference to the banded symmetric matrix to be initialized
+!!  \param hbw  Half bandwidth of the matrix
+!!  \param n    Number of rows/columns in the matrix
+!!  \param exc  Error code
+!!
+!!  This routine initializes the bandSymMatrixT object referenced by self.
+!!  The data structures contained in self are allocated and initial values
+!!  are set to zero. If the specified dimensions are invalid, a SZE
+!!  exception is returned. If allocation of data structures fails, an
+!!  ALLOC exception is returned.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_init_exc_ (self, hbw,n, exc)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+  INTEGER, INTENT(IN) :: hbw,n
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: e      !> allocation info code
+  INTEGER :: i,j    !> loop variables
+
+  !> if dimensions are invalid, raise SZE exception
+  IF (hbw.LE.0 .OR. n.LE.0 .OR. hbw.GT.n) THEN
+    exc=SZE
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> only reallocate if new dimensions do not match existing dimensions
+  IF (bsm_halfBW(self).NE.hbw .OR. bsm_numRows(self).NE.n) THEN
+
+    !> reset object if it was previously initialized
+    CALL bsm_clean(self)
+
+    !> allocate new data structure for matrix storage
+    ALLOCATE(self%dat(hbw,n), STAT=e)
+
+    !> if error code is returned, raise ALLOC exception
+    IF (e.NE.0) THEN
+      exc=ALLOC
+      CALL log_printLogMsg(exc,sdr)
+      CALL bsm_clean(self)
+      RETURN
+    ELSE
+      exc=OK
+    END IF
+
+    !> allocate new data structure for decomposition storage
+    ALLOCATE(self%decomp(hbw,n), STAT=e)
+
+    !> if error code is returned, raise ALLOC exception
+    IF (e.NE.0) THEN
+      exc=ALLOC
+      CALL log_printLogMsg(exc,sdr)
+      CALL bsm_clean(self)
+      RETURN
+    ELSE
+      exc=OK
+    END IF
+
+  END IF
+
+  !> ensure data is initialized to zero
+  DO j = 1,n
+    DO i = 1,hbw
+      self%dat(i,j) = 0.d0
+      self%decomp(i,j) = 0.d0
+    END DO
+  END DO
+
+  !> reset boolean for decomposition
+  self%is_decomposed = .FALSE.
+
+END SUBROUTINE bsm_init_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Destructor for bandSymMatrixT
+!!
+!!  \param self Reference to the banded symmetric matrix to be destroyed
+!!
+!!  This routine deallocates existing data structures and resets the
+!!  switch indicating decomposition.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_clean_ (self)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+
+  !> deallocate data structures
+  IF (ALLOCATED(self%dat)) DEALLOCATE(self%dat)
+  IF (ALLOCATED(self%decomp)) DEALLOCATE(self%decomp)
+
+  !> reset boolean for decomposition
+  self%is_decomposed = .FALSE.
+
+END SUBROUTINE bsm_clean_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for number of rows
+!!
+!!  \param  self  Reference to the banded symmetric matrix object
+!!  \return n     Number of rows in the matrix
+!!
+!!  This routine determines the number of rows allocated to the matrix
+!!  object. If the matrix is not initialized it returns 0.
+! ------------------------------------------------------------------------
+FUNCTION bsm_num_rows_ (self) RESULT(n)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  INTEGER :: n
+
+  !> if data is initialized, return number of rows
+  IF (ALLOCATED(self%dat)) THEN
+    n = SIZE(self%dat,2)
+  ELSE
+    n = 0   !> if not initialized, there are no rows
+  END IF
+
+END FUNCTION bsm_num_rows_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for half bandwidth
+!!
+!!  \param  self  Reference to the banded symmetric matrix object
+!!  \return hbw   Half bandwidth of the matrix
+!!
+!!  This routine determines the half bandwidth allocated to the matrix
+!!  object. If the matrix is not initialized it returns 0.
+! ------------------------------------------------------------------------
+FUNCTION bsm_half_bw_ (self) RESULT(hbw)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  INTEGER :: hbw
+
+  !> if data is initialized, return half bandwidth
+  IF (ALLOCATED(self%dat)) THEN
+    hbw = SIZE(self%dat,1)
+  ELSE
+    hbw = 0   !> if not initialized, there are no bands
+  END IF
+
+END FUNCTION bsm_half_bw_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for matrix entries (non-exception checking)
+!!
+!!  \param  self  Reference to the banded symmetric matrix object
+!!  \param  i     Row index (in unpacked version)
+!!  \param  j     Column index (in unpacked version)
+!!  \return v     Value at location (i,j) of the matrix
+!!
+!!  This routine determines the value at a particular location in the
+!!  matrix. If the location is outside the band, it returns 0.
+! ------------------------------------------------------------------------
+FUNCTION bsm_get_ (self, i,j) RESULT(v)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: v
+  INTEGER :: r,c              !> indices in packed format
+
+  !> get packed indices
+  CALL packed_index(self, i,j, r,c)
+
+  !> if desired location is within the bands, return the value
+  IF (r.GT.0) THEN
+    v = self%dat(r,c)
+  ELSE
+    v = 0.d0    !> if off-band, return 0
+  END IF
+
+END FUNCTION bsm_get_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for matrix entries (exception checking)
+!!
+!!  \param  self  Reference to the banded symmetric matrix object
+!!  \param  i     Row index (in unpacked version)
+!!  \param  j     Column index (in unpacked version)
+!!  \param  exc   Error code
+!!  \return v     Value at location (i,j) of the matrix
+!!
+!!  This routine determines the value at a particular location in the
+!!  matrix. If the location is outside the band, it returns 0. If the
+!!  location is not inside the matrix, it returns a POSIT exception.
+! ------------------------------------------------------------------------
+FUNCTION bsm_get_exc_ (self, i,j, exc) RESULT(v)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: v
+  INTEGER :: n    !> number of rows
+
+  !> get number of rows (for efficiency)
+  n = bsm_numRows(self)
+
+  !> make sure desired indices are inside the matrix
+  IF (i.GT.n .OR. i.LE.0 &
+      .OR. j.GT.n .OR. j.LE.0) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    v = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception getter
+  v = bsm_get(self, i,j)
+
+END FUNCTION bsm_get_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for matrix entries (non-exception checking)
+!!
+!!  \param self Reference to the banded symmetric matrix object
+!!  \param i    Row index (in unpacked version)
+!!  \param j    Column index (in unpacked version)
+!!  \param v    Value to be stored at location (i,j) of the matrix
+!!
+!!  This routine sets the value at a particular location in the
+!!  matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_set_ (self, i,j,v)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: v
+  INTEGER :: r,c        !> indices in packed format
+
+  !> get packed indices
+  CALL packed_index(self, i,j, r,c)
+
+  !> set the data value
+  self%dat(r,c) = v
+
+END SUBROUTINE bsm_set_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for matrix entries (exception checking)
+!!
+!!  \param self Reference to the banded symmetric matrix object
+!!  \param i    Row index (in unpacked version)
+!!  \param j    Column index (in unpacked version)
+!!  \param v    Value to be stored at location (i,j) of the matrix
+!!  \param exc  Error code
+!!
+!!  This routine sets the value at a particular location in the
+!!  matrix. If the location is outside the band or if the
+!!  location is not inside the matrix, it returns a POSIT exception.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_set_exc_ (self, i,j,v, exc)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: v
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: n    !> number of rows
+
+  !> get number of rows (for efficiency)
+  n = bsm_numRows(self)
+
+  !> ensure that desired indices are within the matrix
+  !> and furthermore within the bands
+  IF (i.GT.n .OR. i.LE.0 &
+      .OR. j.GT.n .OR. j.LE.0 &
+      .OR. ABS(j-i).GE.bsm_halfBW(self)) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL bsm_set(self, i,j,v)
+
+END SUBROUTINE bsm_set_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for Cholesky decomposition (non-exception checking)
+!!
+!!  \param self   Reference to the banded symmetric matrix object
+!!  \param decomp Array containing the decomposition in packed format
+!!
+!!  This routine sets the Cholesky decomposition of the matrix object.
+!!  The decomposition is typically determined using the DPBTRF subroutine
+!!  from the LAPACK library.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_set_decomp_ (self,decomp)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+  DOUBLE PRECISION, INTENT(IN) :: decomp(:,:)
+
+  !> set the decomposition data and flip the boolean
+  self%decomp = decomp
+  self%is_decomposed = .TRUE.
+
+END SUBROUTINE bsm_set_decomp_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for Cholesky decomposition (exception checking)
+!!
+!!  \param self   Reference to the banded symmetric matrix object
+!!  \param decomp Array containing the decomposition in packed format
+!!  \param exc    Error code
+!!
+!!  This routine sets the Cholesky decomposition of the matrix object.
+!!  The decomposition is typically determined using the DPBTRF subroutine
+!!  from the LAPACK library. If the dimensions of the provided
+!!  decomposition array do not match those of the allocated array, it
+!!  returns a DIMEN exception.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_set_decomp_exc_ (self,decomp, exc)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+  DOUBLE PRECISION, INTENT(IN) :: decomp(:,:)
+  INTEGER, INTENT(OUT) :: exc
+
+  !> make sure that the dimensions of the proposed decomposition match
+  !> the actual dimensions of the packed storage
+  IF (bsm_halfBW(self).NE.SIZE(decomp,1) &
+        .OR. bsm_numRows(self).NE.SIZE(decomp,2)) THEN
+    exc=DIMEN
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call the non-exception version
+  CALL bsm_setDecomp(self,decomp)
+
+END SUBROUTINE bsm_set_decomp_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for boolean indicating presence of decomposition
+!!
+!!  \param  self          Reference to the banded symmetric matrix object
+!!  \return is_decomposed Boolean indicating whether the decomposition is present
+! ------------------------------------------------------------------------
+FUNCTION bsm_is_decomposed_ (self) RESULT(is_decomposed)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  LOGICAL :: is_decomposed
+
+  is_decomposed = self%is_decomposed
+
+END FUNCTION bsm_is_decomposed_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Add two bandSymMatrixT objects (non-exception checking)
+!!
+!!  \param  self  Reference to the first (left-hand) banded symmetric matrix object
+!!  \param  other Reference to the second (right-hand) banded symmetric matrix object
+!!  \return new   Reference to the resulting banded symmetric matrix object
+!!
+!!  This routine adds two banded symmetric matrix objects. The half
+!!  bandwidth of the result is the maximum of the half bandwidths of the
+!!  input matrix objects.
+! ------------------------------------------------------------------------
+FUNCTION bsm_add_ (self,other) RESULT(new)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self,other
+  TYPE(bandSymMatrixT) :: new
+  INTEGER :: hbw1,hbw2    !> half bandwidths of inputs
+  INTEGER :: hbw,n        !> half bandwidth of output and number of rows
+
+  !> get number of rows and half bandwidths
+  n = bsm_numRows(self)
+  hbw1 = bsm_halfBW(self)
+  hbw2 = bsm_halfBW(other)
+
+  !> new half bandwidth is the maximum of the previous
+  hbw = MAX(hbw1,hbw2)
+
+  !> intialize new bandSymMatrixT
+  CALL bsm_init(new, hbw,n)
+
+  !> add the two matrices (using array ops for efficiency)
+  new%dat(hbw-hbw1+1:hbw,:) = self%dat(:,:)
+  new%dat(hbw-hbw2+1:hbw,:) = new%dat(hbw-hbw2+1:hbw,:) + other%dat(:,:)
+
+END FUNCTION bsm_add_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Add two bandSymMatrixT objects (exception checking)
+!!
+!!  \param  self  Reference to the first (left-hand) banded symmetric matrix object
+!!  \param  other Reference to the second (right-hand) banded symmetric matrix object
+!!  \param  exc   Error code
+!!  \return new   Reference to the resulting banded symmetric matrix object
+!!
+!!  This routine adds two banded symmetric matrix objects. The half
+!!  bandwidth of the result is the maximum of the half bandwidths of the
+!!  input matrix objects. If the dimensions of the two input matrices do
+!!  not match, it returns a DIMEN exception.
+! ------------------------------------------------------------------------
+FUNCTION bsm_add_exc_ (self,other, exc) RESULT(new)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self,other
+  INTEGER, INTENT(OUT) :: exc
+  TYPE(bandSymMatrixT) :: new
+
+  !> make sure that the two matrices have the same number of rows
+  IF (bsm_numRows(self).NE.bsm_numRows(other)) THEN
+    exc=DIMEN
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  new = bsm_add(self,other)
+
+END FUNCTION bsm_add_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Add a matrixT to a bandSymMatrixT in place with mapping (non-exception checking)
+!!
+!!  \param self   Reference to the banded symmetric matrix object
+!!  \param other  Reference to the dense matrix object
+!!  \param ind    Integer mapping indices
+!!
+!!  This routine adds a dense matrix to a banded symmetric matrix in place
+!!  according to an indexed mapping. That is, the element at (i,j) in
+!!  other is added to the element at (ind(i),ind(j)) of self.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_mapped_add_ (self, other,ind)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+  TYPE(matrixT), INTENT(IN) :: other
+  INTEGER, INTENT(IN) :: ind(:)
+  INTEGER :: i,j    !> loop variables
+
+  !> Add matrix entries corresponding to mapping indices
+  DO i = 1,SIZE(ind)
+
+    IF (ind(i).EQ.0)  CYCLE
+
+    DO j = i,SIZE(ind)
+
+      IF (ind(j).EQ.0) CYCLE
+
+      CALL bsm_set(self, ind(i),ind(j), &
+                    bsm_get(self,ind(i),ind(j)) &
+                    + dm_get(other,i,j) )
+
+    END DO
+  END DO
+
+END SUBROUTINE bsm_mapped_add_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Add a matrixT to a bandSymMatrixT in place with mapping (exception checking)
+!!
+!!  \param self   Reference to the banded symmetric matrix object
+!!  \param other  Reference to the dense matrix object
+!!  \param ind    Integer mapping indices
+!!  \param exc    Error code
+!!
+!!  This routine adds a dense matrix to a banded symmetric matrix in place
+!!  according to an indexed mapping. That is, the element at (i,j) in
+!!  other is added to the element at (ind(i),ind(j)) of self. If the
+!!  dense matrix is not square or if the its dimensions exceed the half
+!!  bandwidth of the banded symmetric matrix, it returns a DIMEN
+!!  exception. If the number of mapping indices does not match the
+!!  dimension of the dense matrix, it returns a DIMEN exception. If any of
+!!  the index pairs indicate a location outside the matrix bands, it
+!!  returns a POSIT exception. Note that a zero index is valid and
+!!  ind(i)=0 or ind(j)=0 indicate that the value at (i,j) in the dense
+!!  matrix object will not be added to the banded symmetric matrix object.
+! ------------------------------------------------------------------------
+SUBROUTINE bsm_mapped_add_exc_ (self, other,ind, exc)
+  TYPE(bandSymMatrixT), INTENT(INOUT) :: self
+  TYPE(matrixT), INTENT(IN) :: other
+  INTEGER, INTENT(IN) :: ind(:)
+  INTEGER, INTENT(OUT) :: exc
+
+  !> ensure that matrixT is square (it is assumed to be symmetric)
+  !> and that the number of rows in the matrixT matches the number
+  !> of mapping indices
+  !> and that the matrixT is not wider than the half bandwidth
+  !> of the bandSymMatrixT
+  IF (dm_numRows(other).NE.dm_numCols(other) &
+      .OR. dm_numRows(other).NE.SIZE(ind) &
+      .OR. dm_numRows(other).GT.bsm_halfBW(self)) THEN
+    exc=DIMEN
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  !> ensure that there are no mapping indices outside the bandSymMatrixT
+  !> and that all indices are within the bands
+  ELSEIF ( MAXVAL(ind).GT.bsm_numRows(self) .OR. MINVAL(ind).LT.0 &
+            .OR. MAXVAL(ind)-MINVAL(ind,MASK=ind.GT.0) .GE. bsm_halfBW(self) ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL bsm_mappedAdd(self,other,ind)
+
+END SUBROUTINE bsm_mapped_add_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Scalar multiplication (self*k version)
+!!
+!!  \param  self  Reference to the banded symmetric matrix object
+!!  \param  k     Scalar multiplication factor
+!!  \return new   Reference to the resulting banded symmetric matrix object
+!!
+!!  This routine multiplies a banded symmetric matrix by a scalar factor.
+! ------------------------------------------------------------------------
+FUNCTION bsm_scal_mul_mat_scal_ (self,k) RESULT(new)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  DOUBLE PRECISION, INTENT(IN) :: k
+  TYPE(bandSymMatrixT) :: new
+
+  !> initialize output
+  CALL bsm_init(new, bsm_halfBW(self),bsm_numRows(self))
+
+  !> perform multiplication
+  new%dat = k * self%dat
+
+END FUNCTION bsm_scal_mul_mat_scal_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Scalar multiplication (k*self version)
+!!
+!!  \param  self  Reference to the banded symmetric matrix object
+!!  \param  k     Scalar multiplication factor
+!!  \return new   Reference to the resulting banded symmetric matrix object
+!!
+!!  This routine multiplies a banded symmetric matrix by a scalar factor.
+!!  The overload is necessary for the OPERATOR (*) overload. This version
+!!  simply calls the other version for better maintainability.
+! ------------------------------------------------------------------------
+FUNCTION bsm_scal_mul_scal_mat_ (k,self) RESULT(new)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  DOUBLE PRECISION, INTENT(IN) :: k
+  TYPE(bandSymMatrixT) :: new
+
+  !> call self*k version
+  new = bsm_scalMul(self,k)
+
+END FUNCTION bsm_scal_mul_scal_mat_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Post-multiplication of a banded symmetric matrix by a vector (non-exception checking)
+!!
+!!  \param  self  Reference to the banded symmetric matrix object
+!!  \param  other Reference to the vector object
+!!  \return new   Reference to the resulting vector object
+!!
+!!  This routine post-multiplies a banded symmetric matrix by a vector.
+!!  That is, it performs self*other, not other*self.
+! ------------------------------------------------------------------------
+FUNCTION bsm_vec_mul_ (self,other) RESULT(new)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  TYPE(vectorT), INTENT(IN) :: other
+  TYPE(vectorT) :: new
+  INTEGER :: hbw,n    !> half bandwidth and number of rows
+  INTEGER :: i,j      !> loop variables
+
+  !> get size parameters
+  n = vec_length(other)
+  hbw = bsm_halfBW(self)
+
+  !> initialize solution
+  CALL vec_init(new, n)
+
+  !> perform partial dot products of rows in self with the vector
+  !> (ignoring off-band zeros)
+  DO i = 1,n
+    DO j = MAX(i-hbw+1,1), MIN(i+hbw-1,n)
+      CALL vec_set(new, i, vec_get(new,i) + bsm_get(self,i,j)*vec_get(other,j))
+    END DO
+  END DO
+
+END FUNCTION bsm_vec_mul_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Post-multiplication of a banded symmetric matrix by a vector (exception checking)
+!!
+!!  \param  self  Reference to the banded symmetric matrix object
+!!  \param  other Reference to the vector object
+!!  \param  exc   Error code
+!!  \return new   Reference to the resulting vector object
+!!
+!!  This routine post-multiplies a banded symmetric matrix by a vector.
+!!  That is, it performs self*other, not other*self. If the dimensions
+!!  of the two objects are not compatible, it returns a DIMEN exception.
+! ------------------------------------------------------------------------
+FUNCTION bsm_vec_mul_exc_ (self,other, exc) RESULT(new)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  TYPE(vectorT), INTENT(IN) :: other
+  INTEGER, INTENT(OUT) :: exc
+  TYPE(vectorT) :: new
+
+  !> ensure that the number of rows in the bandSymMatrixT and
+  !> the vectorT match
+  IF (bsm_numRows(self).NE.vec_length(other)) THEN
+    exc=DIMEN
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  new = bsm_vecMul(self,other)
+
+END FUNCTION bsm_vec_mul_exc_
+
+
+
+! ************************************************************************
+! LOCAL FUNCTIONS
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Determine the packed indices from the non-packed indices
+!!
+!!  \param self Reference to the banded symmetric matrix object
+!!  \param i    Row index (non-packed version)
+!!  \param j    Column index (non-packed version)
+!!  \param r    Row index (packed version)
+!!  \param c    Column index (packed version)
+!!
+!!  This routine determines the indices of the desired location in the
+!!  matrix in the packed data structure. It accounts for symmetry by
+!!  ensuring that i <= j. After that is checked, the packed indices are
+!!  computed as:  r = hbw - (j-i)
+!!                c = j
+! ------------------------------------------------------------------------
+SUBROUTINE packed_index (self, i,j, r,c)
+  TYPE(bandSymMatrixT), INTENT(IN) :: self
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: r,c
+
+  !> flip indices - symmetry
+  IF (i.GT.j) THEN
+    r=j
+    c=i
+  ELSE
+    r=i
+    c=j
+  END IF
+
+  !> convert to packed index
+  r = bsm_halfBW(self) - (c-r)
+
+END SUBROUTINE packed_index
+
+END MODULE band_sym_matrix_def

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/band_sym_matrix_test.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module for testing Banded Symmetric Matrix data type
+! ------------------------------------------------------------------------
+MODULE band_sym_matrix_test
+USE fruit                   !> Unit testing framework
+USE log_message_control     !> Printing log/error messages
+USE log_messages            !> Log/error codes
+USE band_sym_matrix_def     !> Banded Symmetric Matrix data type
+USE dense_matrix_def        !> Dense Matrix data type
+USE vector_def              !> Vector data type
+
+IMPLICIT NONE
+
+
+CONTAINS
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for OK exception message on allocation
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test       Test banded symmetric matrix
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!
+!!  This test initializes a bandSymMatrixT and makes sure that the
+!!  exception message is OK (i.e. allocation did not fail).
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_allocation_MSG
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_allocation_MSG'
+  TYPE(bandSymMatrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=OK
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log message file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrix and check the exception
+  CALL bsm_init(test, hbw,n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrix
+  CALL log_closeLogFile()
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_allocation_MSG
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for SZE exception message on allocation
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test banded symmetric matrix
+!!  \param testName Filename for log file (required for exceptions)
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param expMsg   Expected log message
+!!  \param actMsg   Actual log message
+!!
+!!  This test attempts to initialize a bandSymMatrixT with invalid size
+!!  parameters and verifies that the correct exception is returned.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_allocation_SZE
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_allocation_SZE'
+  TYPE(bandSymMatrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=SZE
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> try to initialize with hbw=-1
+  CALL bsm_init(test, -1,n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to initialize with n=-1
+  CALL bsm_init(test, hbw,-1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrix
+  CALL log_closeLogFile()
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_allocation_SZE
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for initialization of matrix data to zeros.
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test banded symmetric matrix
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param expDat   Expected initial contents of matrix data
+!!
+!!  This test initializes a bandSymMatrixT and ensures that the data is
+!!  initialized to zeros.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_allocation_DAT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_allocation_DAT'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up the expected data (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize matrix and test actual data
+  CALL bsm_init(test, hbw,n)
+  CALL assertEquals(expDat,test%dat, hbw,n)
+  CALL assertEquals(expDat,test%decomp, hbw,n)
+
+  !> deallocate matrix
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_allocation_DAT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for deallocation
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test       Test banded symmetric matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expBefore  Expected allocation status before deallocation
+!!  \param expAfter   Expected allocation status after deallocation
+!!  \param actBefore  Actual allocation status before deallocation
+!!  \param actAfter   Actual allocation status after deallocation
+!!
+!!  This test initializes a bandSymMatrixT and ensures that it is
+!!  allocated. It then deallocates the object and ensures that it has
+!!  been deallocated.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_deallocation
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_deallocation'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: hbw=3,n=10
+  LOGICAL, PARAMETER :: expBefore = .TRUE.
+  LOGICAL, PARAMETER :: expAfter = .FALSE.
+  LOGICAL :: actBefore, actAfter
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> make sure dat is allocated
+  actBefore = ALLOCATED(test%dat)
+  CALL assertEquals(expBefore,actBefore)
+
+  !> make sure decomp is allocated
+  actBefore = ALLOCATED(test%decomp)
+  CALL assertEquals(expBefore,actBefore)
+
+  !> deallocate the matrix
+  CALL bsm_clean(test)
+
+  !> make sure dat is deallocated
+  actAfter = ALLOCATED(test%dat)
+  CALL assertEquals(expAfter,actAfter)
+
+  !> make sure decomp is deallocated
+  actAfter = ALLOCATED(test%decomp)
+  CALL assertEquals(expAfter,actAfter)
+
+END SUBROUTINE test_bsm_deallocation
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for number of rows when matrix is not allocated
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test       Test banded symmetric matrix
+!!  \param expected   Expected number of rows
+!!  \param actual     Actual number of rows
+!!
+!!  This test makes sure that the number of rows is returned as 0 when
+!!  the matrix is not allocated
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_num_rows_not_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_num_rows_not_allocated'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: expected = 0
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> check number of rows
+  actual = bsm_numRows(test)
+  CALL assertEquals(expected, actual)
+
+END SUBROUTINE test_bsm_num_rows_not_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for number of rows when matrix is allocated
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test       Test banded symmetric matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expected   Expected number of rows
+!!  \param actual     Actual number of rows
+!!
+!!  This test checks that the number of rows returned is correct when the
+!!  matrix is allocated.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_num_rows_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_num_rows_allocated'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expected = n
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> check number of rows
+  actual = bsm_numRows(test)
+  CALL assertEquals(expected, actual)
+
+  !> deallocate the matrix
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_num_rows_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for half bandwidth when matrix is not allocated
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test       Test banded symmetric matrix
+!!  \param expected   Expected number of rows
+!!  \param actual     Actual number of rows
+!!
+!!  This test makes sure that the half bandwidth is returned as 0 when
+!!  the matrix is not allocated
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_half_bw_not_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_half_bw_not_allocated'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: expected = 0
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> check the half bandwidth
+  actual = bsm_halfBW(test)
+  CALL assertEquals(expected, actual)
+
+END SUBROUTINE test_bsm_half_bw_not_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for half bandwidth when matrix is allocated
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test       Test banded symmetric matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expected   Expected number of rows
+!!  \param actual     Actual number of rows
+!!
+!!  This test checks that the half bandwidth returned is correct when the
+!!  matrix is allocated.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_half_bw_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_half_bw_allocated'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expected = hbw
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> check the half bandwidth
+  actual = bsm_halfBW(test)
+  CALL assertEquals(expected, actual)
+
+  !> deallocate the matrix
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_half_bw_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception from bsm_get
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test banded symmetric matrix
+!!  \param testName Filename for log file (required for exceptions)
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param expMsg   Expected log message
+!!  \param actMsg   Actual log message
+!!  \param v        Dummy variable for get function return
+!!
+!!  This test checks that a POSIT exception is returned when the requested
+!!  location is not inside the matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_get_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_get_POSIT'
+  TYPE(bandSymMatrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg = POSIT
+  INTEGER :: actMsg
+  DOUBLE PRECISION :: v
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> try to get beyond last row
+  v = bsm_get(test, n+1,n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first row
+  v = bsm_get(test, 0,n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get after last column
+  v = bsm_get(test, n,n+1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first column
+  v = bsm_get(test, n,0, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate the matrix
+  CALL log_closeLogFile()
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_get_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct value return from bsm_get
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test banded symmetric matrix
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param i        Row index for test location
+!!  \param j        Column index for test location
+!!  \param expVal   Expected data value
+!!  \param actVal   Actual data value
+!!
+!!  This test checks that the correct value is returned from the get
+!!  access program (i.e. that the location is interpreted correctly from
+!!  the unpacked indices).
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_get_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_get_VAL'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: i=3,j=5
+  DOUBLE PRECISION, PARAMETER :: expVal = 3.d0
+  DOUBLE PRECISION :: actVal
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> set the value manually in the internal data structure
+  test%dat(hbw+i-j,j) = expVal
+
+  !> get the value using the access program
+  actVal = bsm_get(test, i,j)
+  CALL assertEquals(expVal,actVal)
+
+  !> get the value using the access program (testing symmetry)
+  actVal = bsm_get(test, j,i)
+  CALL assertEquals(expVal,actVal)
+
+  !> deallocate the matrix
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_get_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception from bsm_set
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test banded symmetric matrix
+!!  \param testName Filename for log file (required for exceptions)
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param expMsg   Expected log message
+!!  \param actMsg   Actual log message
+!!  \param v        Dummy variable for set function input
+!!
+!!  This test checks that a POSIT exception is returned when the requested
+!!  location is not inside the matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_set_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_set_POSIT'
+  TYPE(bandSymMatrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg = POSIT
+  DOUBLE PRECISION, PARAMETER :: v=0.d0
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize the matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> try to set after last row
+  CALL bsm_set(test, n+1,n,v, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set before first row
+  CALL bsm_set(test, 0,n,v, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set after last column
+  CALL bsm_set(test, n,n+1,v, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set before first column
+  CALL bsm_set(test, n,0,v, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrix
+  CALL log_closeLogFile()
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_set_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct value return after bsm_set
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test banded symmetric matrix
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param i        Row index for test location
+!!  \param j        Column index for test location
+!!  \param expVal   Expected data value
+!!  \param actVal   Actual data value
+!!  \param reset    For resetting data value before symmetry test
+!!
+!!  This test checks that the correct value is entered by the set
+!!  access program (i.e. that the location is interpreted correctly from
+!!  the unpacked indices).
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_set_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_set_VAL'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: i=3,j=5
+  DOUBLE PRECISION, PARAMETER :: expVal = 3.d0
+  DOUBLE PRECISION, PARAMETER :: reset = 0.d0
+  DOUBLE PRECISION :: actVal
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> set the value
+  CALL bsm_set(test, i,j,expVal)
+  actVal = bsm_get(test, i,j)
+  CALL assertEquals(expVal,actVal)
+
+  !> set the value (symmetry)
+  CALL bsm_set(test, i,j,reset)
+  CALL bsm_set(test, j,i,expVal)
+  actVal = bsm_get(test, i,j)
+  CALL assertEquals(expVal,actVal)
+
+  !> deallocate matrix
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_set_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception on setting decomposed matrix data
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test banded symmetric matrix
+!!  \param testName Filename for log file (required for exceptions)
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param expMsg   Expected log message
+!!  \param actMsg   Actual log message
+!!  \param decomp   Dummy data that has incorrect dimensions
+!!
+!!  This test checks that a DIMEN exception is returned when the
+!!  decomposed data has incorrect dimensions. That is, not (hbw,n).
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_set_decomp_DIMEN
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_set_decomp_DIMEN'
+  TYPE(bandSymMatrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg = DIMEN
+  DOUBLE PRECISION, DIMENSION(hbw-1,n) :: decomp
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up dummy data (note: Fortran uses column-major storage)
+  decomp = RESHAPE( (/ &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0  &
+                    /), SHAPE(decomp) )
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> try to set the decomposed data
+  CALL bsm_setDecomp(test,decomp, actMsg)
+  CALL assertEquals(expMsg, actMsg)
+
+  !> finalize log file and deallocate matrix
+  CALL log_closeLogFile()
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_set_decomp_DIMEN
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct setting of decomposed data
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test         Test banded symmetric matrix
+!!  \param hbw          Half bandwidth of the matrix
+!!  \param n            Number of rows/columns in the matrix
+!!  \param expDecomp    Expected decomposed data
+!!
+!!  This test checks that the decomposed data is correctly set.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_set_decomp_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_set_decomp_VAL'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDecomp
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up decomposed data (note: Fortran uses column-major storage)
+  expDecomp = RESHAPE((/ &
+                      0.d0,0.d0,1.d0,0.d0,2.d0,3.d0,4.d0,5.d0,6.d0,7.d0, &
+                      8.d0,9.d0,0.d0,1.d0,2.d0,3.d0,4.d0,5.d0,6.d0,7.d0, &
+                      8.d0,9.d0,0.d0,1.d0,2.d0,3.d0,4.d0,5.d0,6.d0,7.d0  &
+                      /), SHAPE(expDecomp) )
+
+  !> initialize matrix
+  CALL bsm_init(test, hbw,n)
+
+  !> set the decomposed data
+  CALL bsm_setDecomp(test,expDecomp)
+  CALL assertEquals(expDecomp, test%decomp, hbw,n)
+
+  !> deallocate matrix
+  CALL bsm_clean(test)
+
+END SUBROUTINE test_bsm_set_decomp_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct status of switch for decomposed data
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test       Test banded symmetric matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expBefore  Expected value of switch before setting decomp
+!!  \param expAfter   Expected value of switch after setting decomp
+!!  \param expClean   Expected value of switch after deallocating matrix
+!!  \param actBefore  Actual value of switch before setting decomp
+!!  \param actAfter   Actual value of switch after setting decomp
+!!  \param actClean   Actual value of switch after deallocating matrix
+!!  \param decomp     Dummy decomposed data
+!!
+!!  This test checks that the presence of decomposed data is correctly
+!!  identified.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_is_decomposed
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_is_decomposed'
+  TYPE(bandSymMatrixT) :: test
+  INTEGER, PARAMETER :: hbw=3,n=10
+  LOGICAL, PARAMETER :: expBefore = .FALSE.
+  LOGICAL, PARAMETER :: expAfter = .TRUE.
+  LOGICAL, PARAMETER :: expClean = .FALSE.
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: decomp
+  LOGICAL :: actBefore, actAfter, actClean
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize matrix and check initial value of switch
+  CALL bsm_init(test, hbw,n)
+  actBefore = bsm_isDecomposed(test)
+  CALL assertEquals(expBefore,actBefore)
+
+  !> set up decomposed data (note: Fortran uses column-major storage)
+  decomp = RESHAPE( (/ &
+                    0.d0,0.d0,1.d0,0.d0,2.d0,3.d0,4.d0,5.d0,6.d0,7.d0, &
+                    8.d0,9.d0,0.d0,1.d0,2.d0,3.d0,4.d0,5.d0,6.d0,7.d0, &
+                    8.d0,9.d0,0.d0,1.d0,2.d0,3.d0,4.d0,5.d0,6.d0,7.d0  &
+                    /), SHAPE(decomp) )
+
+  !> set decomposed data
+  CALL bsm_setDecomp(test,decomp)
+  actAfter = bsm_isDecomposed(test)
+  CALL assertEquals(expAfter,actAfter)
+
+  !> deallocate matrix and check final value of decomposed switch
+  CALL bsm_clean(test)
+  actClean = bsm_isDecomposed(test)
+  CALL assertEquals(expClean,actClean)
+
+END SUBROUTINE test_bsm_is_decomposed
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception when adding matrices
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      First input banded symmetric matrix
+!!  \param test2      Second input banded symmetric matrix
+!!  \param test3      Output banded symmetric matrix
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!
+!!  This test checks that a DIMEN exception is raised when matrices with
+!!  incompatible dimensions are added.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_add_DIMEN
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_add_DIMEN'
+  TYPE(bandSymMatrixT) :: test1, test2, test3
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=DIMEN
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize input matrices (data contents not important)
+  CALL bsm_init(test1, hbw,n)
+  CALL bsm_init(test2, hbw,n+1) !> note different dimension
+
+  !> attempt to add the matrices
+  test3 = bsm_add(test1,test2, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrices
+  CALL log_closeLogFile()
+  CALL bsm_clean(test1)
+  CALL bsm_clean(test2)
+  CALL bsm_clean(test3)
+
+END SUBROUTINE test_bsm_add_DIMEN
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct addition of matrices
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      First input banded symmetric matrix
+!!  \param test2      Second input banded symmetric matrix
+!!  \param test3      Output banded symmetric matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected result of addition
+!!
+!!  This test checks that the correct result is obtained when adding two
+!!  banded symmetric matrices.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_add_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_add_VAL'
+  TYPE(bandSymMatrixT) :: test1, test2, test3
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+  INTEGER :: i,j  !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,3.d0,0.d0,3.d0,3.d0,1.d0,3.d0,3.d0,1.d0, &
+                    3.d0,3.d0,1.d0,3.d0,3.d0,1.d0,3.d0,3.d0,1.d0,3.d0, &
+                    3.d0,1.d0,3.d0,3.d0,1.d0,3.d0,3.d0,1.d0,3.d0,3.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize first input matrix
+  !! (loop sets matrix on bands to all ones)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    DO j = i,MIN(i+hbw-1,n)
+      CALL bsm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> initialize second input matrix (note different bandwidth)
+  !! (loop sets matrix on bands to all twos)
+  CALL bsm_init(test2, hbw-1,n)
+  DO i = 1,n
+    DO j = i,MIN(i+(hbw-1)-1,n)
+     CALL bsm_set(test2, i,j, 2.d0)
+    END DO
+  END DO
+
+  !> add the matrices
+  test3 = bsm_add(test1,test2)
+  CALL assertEquals(expDat,test3%dat, hbw,n)
+
+  !> deallocate matrices
+  CALL bsm_clean(test1)
+  CALL bsm_clean(test2)
+  CALL bsm_clean(test3)
+
+END SUBROUTINE test_bsm_add_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct addition of matrices ( with OPERATOR (+) )
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      First input banded symmetric matrix
+!!  \param test2      Second input banded symmetric matrix
+!!  \param test3      Output banded symmetric matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected result of addition
+!!
+!!  This test checks that the correct result is obtained when adding two
+!!  banded symmetric matrices using the (+) operator.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_add_OP
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_add_OP'
+  TYPE(bandSymMatrixT) :: test1, test2, test3
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+  INTEGER :: i,j  !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,3.d0,0.d0,3.d0,3.d0,1.d0,3.d0,3.d0,1.d0, &
+                    3.d0,3.d0,1.d0,3.d0,3.d0,1.d0,3.d0,3.d0,1.d0,3.d0, &
+                    3.d0,1.d0,3.d0,3.d0,1.d0,3.d0,3.d0,1.d0,3.d0,3.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize first input matrix
+  !! (loop sets matrix on bands to all ones)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    DO j = i,MIN(i+hbw-1,n)
+      CALL bsm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> initialize second input matrix (note different bandwidth)
+  !! (loop sets matrix on bands to all twos)
+  CALL bsm_init(test2, hbw-1,n)
+  DO i = 1,n
+    DO j = i,MIN(i+(hbw-1)-1,n)
+     CALL bsm_set(test2, i,j, 2.d0)
+    END DO
+  END DO
+
+  !> add the matrices
+  test3 = test1 + test2
+  CALL assertEquals(expDat,test3%dat, hbw,n)
+
+  !> deallocate matrices
+  CALL bsm_clean(test1)
+  CALL bsm_clean(test2)
+  CALL bsm_clean(test3)
+
+END SUBROUTINE test_bsm_add_OP
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception when performing mapped add
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Test banded symmetric matrix
+!!  \param test2      Test input dense matrix
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!  \param ind        Mapping indices (size does not match test2)
+!!
+!!  This test checks that a DIMEN exception is raised when mapped addition
+!!  is attempted with the dimension of the index array not matching the
+!!  dimensions of the dense matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_mapped_add_DIMEN1
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_mapped_add_DIMEN1'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(matrixT) :: test2
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=DIMEN
+  INTEGER, PARAMETER, DIMENSION(hbw-1) :: ind = (/ 1,2 /)
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrices (data content not important)
+  CALL bsm_init(test1, hbw,n)
+  CALL dm_init(test2, hbw,hbw)
+
+  !> try mapped add (note hbw=3, SIZE(ind)=2)
+  CALL bsm_mappedAdd(test1, test2,ind, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrices
+  CALL log_closeLogFile()
+  CALL bsm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_bsm_mapped_add_DIMEN1
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception when performing mapped add
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Test banded symmetric matrix
+!!  \param test2      Test input dense matrix (not square)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!  \param ind        Mapping indices
+!!
+!!  This test checks that a DIMEN exception is raised when mapped addition
+!!  is attempted with a rectangular input dense matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_mapped_add_DIMEN2
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_mapped_add_DIMEN2'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(matrixT) :: test2
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=DIMEN
+  INTEGER, PARAMETER, DIMENSION(hbw) :: ind = (/ 1,2,3 /)
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrices (note test2 is not square)
+  CALL bsm_init(test1, hbw,n)
+  CALL dm_init(test2, hbw+1,hbw)
+
+  !> attempt mapped add
+  CALL bsm_mappedAdd(test1, test2,ind, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrices
+  CALL log_closeLogFile()
+  CALL bsm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_bsm_mapped_add_DIMEN2
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception when performing mapped add
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Test banded symmetric matrix
+!!  \param test2      Test input dense matrix (larger than hbw)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!  \param ind        Mapping indices (larger than hbw)
+!!
+!!  This test checks that a DIMEN exception is raised when mapped addition
+!!  is attempted with an input dense matrix whose size exceeds the half
+!!  bandwidth of the banded symmetric matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_mapped_add_DIMEN3
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_mapped_add_DIMEN3'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(matrixT) :: test2
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=DIMEN
+  INTEGER, PARAMETER, DIMENSION(hbw+1) :: ind = (/ 1,2,3,4 /)
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrices (note that test2 is wider than hbw)
+  CALL bsm_init(test1, hbw,n)
+  CALL dm_init(test2, hbw+1,hbw+1)
+
+  !> attempt mapped add
+  CALL bsm_mappedAdd(test1, test2,ind, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrices
+  CALL log_closeLogFile()
+  CALL bsm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_bsm_mapped_add_DIMEN3
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception when performing mapped add
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Test banded symmetric matrix
+!!  \param test2      Test input dense matrix
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!  \param ind1       Mapping indices (with index below minimum)
+!!  \param ind2       Mapping indices (with index above maximum)
+!!
+!!  This test checks that a POSIT exception is raised when mapped addition
+!!  is attempted with mapping indices that are outside the matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_mapped_add_POSIT1
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_mapped_add_POSIT1'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(matrixT) :: test2
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=POSIT
+  INTEGER, PARAMETER, DIMENSION(hbw) :: ind1 = (/ -1,0,1 /)
+  INTEGER, PARAMETER, DIMENSION(hbw) :: ind2 = (/ 9,10,11 /)
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrices (data not important)
+  CALL bsm_init(test1, hbw,n)
+  CALL dm_init(test2, hbw,hbw)
+
+  !> attempt first mapped add
+  CALL bsm_mappedAdd(test1, test2,ind1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> attempt second mapped add
+  CALL bsm_mappedAdd(test1, test2,ind2, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrices
+  CALL log_closeLogFile()
+  CALL bsm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_bsm_mapped_add_POSIT1
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception when performing mapped add
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Test banded symmetric matrix
+!!  \param test2      Test input dense matrix
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!  \param ind        Mapping indices (range of indices >= half bandwidth)
+!!
+!!  This test checks that a POSIT exception is raised when mapped addition
+!!  is attempted with mapping indices that have a difference equal to the
+!!  half bandwidth (i.e. trying to set a value outside the band).
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_mapped_add_POSIT2
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_mapped_add_POSIT2'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(matrixT) :: test2
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=POSIT
+  INTEGER, PARAMETER, DIMENSION(hbw) :: ind = (/ 4,6,9 /)
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrices (data content not important)
+  CALL bsm_init(test1, hbw,n)
+  CALL dm_init(test2, hbw,hbw)
+
+  !> attempt mapped add
+  CALL bsm_mappedAdd(test1, test2,ind, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrices
+  CALL log_closeLogFile()
+  CALL bsm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_bsm_mapped_add_POSIT2
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct mapped addition (single operation)
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Test banded symmetric matrix
+!!  \param test2      Test input dense matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected data contents
+!!  \param ind        Mapping indices
+!!
+!!  This test checks that mapped addition is performed correctly. The
+!!  operation is performed once on a blank matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_mapped_add_VAL1
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_mapped_add_VAL1'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(matrixT) :: test2
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER, DIMENSION(2) :: ind = (/ 1,3 /)
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set expected result of mapped addition (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,1.d0,0.d0,0.d0,0.d0,2.d0,0.d0,3.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize target matrix
+  CALL bsm_init(test1, hbw,n)
+
+  !> initialize input matrix
+  !! (loop sets the data contents)
+  CALL dm_init(test2, 2,2)
+  DO j = 1,2
+    DO i = 1,2
+      CALL dm_set(test2, i,j, ( (DBLE(j)-1.d0) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> perform mapped addition
+  CALL bsm_mappedAdd(test1, test2,ind)
+  CALL assertEquals(expDat,test1%dat, hbw,n)
+
+  !> deallocate matrices
+  CALL bsm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_bsm_mapped_add_VAL1
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct mapped addition (zero index)
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Test banded symmetric matrix
+!!  \param test2      Test input dense matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected data contents
+!!  \param ind        Mapping indices (with zero index indicating no-op)
+!!
+!!  This test checks that mapped addition is performed correctly. The
+!!  mapping index contains a zero, which should tell the mapped adder to
+!!  skip that location in the input matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_mapped_add_VAL2
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_mapped_add_VAL2'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(matrixT) :: test2
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER, DIMENSION(3) :: ind = (/ 1,0,3 /)
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,1.d0,0.d0,0.d0,0.d0,3.d0,0.d0,5.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize target matrix
+  CALL bsm_init(test1, hbw,n)
+
+  !> initialize input matrix
+  !! (loop sets the input data)
+  CALL dm_init(test2, 3,3)
+  DO j = 1,3
+    DO i = 1,3
+      CALL dm_set(test2, i,j, ( (DBLE(j)-1.d0) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> perform mapped addition
+  CALL bsm_mappedAdd(test1, test2,ind)
+  CALL assertEquals(expDat,test1%dat, hbw,n)
+
+  !> deallocate matrices
+  CALL bsm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_bsm_mapped_add_VAL2
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct mapped addition (multiple operations)
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Test banded symmetric matrix
+!!  \param test2      First test input dense matrix
+!!  \param test3      Second test input dense matrix
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected data contents
+!!  \param ind2       Mapping indices for test2
+!!  \param ind3       Mapping indices for test3
+!!
+!!  This test checks that mapped addition is performed correctly. The
+!!  operation is performed twice to ensure summation of overlapping
+!!  values. That is, input is added to existing data in the target matrix
+!!  rather than overwriting.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_mapped_add_VAL3
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_mapped_add_VAL3'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(matrixT) :: test2,test3
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER, DIMENSION(2) :: ind2 = (/ 1,3 /)
+  INTEGER, PARAMETER, DIMENSION(3) :: ind3 = (/ 1,0,3 /)
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,2.d0,0.d0,0.d0,0.d0,5.d0,0.d0,8.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize target matrix
+  CALL bsm_init(test1, hbw,n)
+
+  !> initialize first input matrix
+  !! (loop sets up the data)
+  CALL dm_init(test2, 2,2)
+  DO j = 1,2
+    DO i = 1,2
+      CALL dm_set(test2, i,j, ( (DBLE(j)-1.d0) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize second input matrix
+  !! (loop sets up the data)
+  CALL dm_init(test3, 3,3)
+  DO j = 1,3
+    DO i = 1,3
+      CALL dm_set(test3, i,j, ( (DBLE(j)-1.d0) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> perform the mapped addition for both inputs
+  CALL bsm_mappedAdd(test1, test2,ind2)
+  CALL bsm_mappedAdd(test1, test3,ind3)
+  CALL assertEquals(expDat,test1%dat, hbw,n)
+
+  !> deallocate matrices
+  CALL bsm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_bsm_mapped_add_VAL3
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for scalar multiplication
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1    Input banded symmetric matrix
+!!  \param test2    Output banded symmetric matrix
+!!  \param k        Scalar coefficient
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param expDat   Expected data contents
+!!
+!!  This test checks that scalar multiplication is performed correctly.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_scal_mul_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_scal_mul_VAL'
+  TYPE(bandSymMatrixT) :: test1, test2
+  DOUBLE PRECISION, PARAMETER :: k=3.d0
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+  INTEGER :: i,j    !> loop variable
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,3.d0,0.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0, &
+                    3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0, &
+                    3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize matrix
+  !! (loop sets band to ones)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    DO j = i,MIN(i+hbw-1,n)
+      CALL bsm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> multiply by scalar
+  test2 = bsm_scalMul(test1,k)
+  CALL assertEquals(expDat,test2%dat, hbw,n)
+
+  !> deallocate matrices
+  CALL bsm_clean(test1)
+  CALL bsm_clean(test2)
+
+END SUBROUTINE test_bsm_scal_mul_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for scalar multiplication (by zero)
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1    Input banded symmetric matrix
+!!  \param test2    Output banded symmetric matrix
+!!  \param k        Scalar coefficient (zero)
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param expDat   Expected data contents
+!!
+!!  This test checks that scalar multiplication results in a zero matrix
+!!  when the scalar factor is zero.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_scal_mul_ZERO
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_scal_mul_ZERO'
+  TYPE(bandSymMatrixT) :: test1, test2
+  DOUBLE PRECISION, PARAMETER :: k=0.d0
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected data (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0, &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize matrix
+  !! (loop sets band to ones)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    DO j = i,MIN(i+hbw-1,n)
+      CALL bsm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> multiply by zero
+  test2 = bsm_scalMul(test1,k)
+  CALL assertEquals(expDat,test2%dat, hbw,n)
+
+  !> deallocate matrices
+  CALL bsm_clean(test1)
+  CALL bsm_clean(test2)
+
+END SUBROUTINE test_bsm_scal_mul_ZERO
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for scalar multiplication ( using OPERATOR (*) )
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1    Input banded symmetric matrix
+!!  \param test2    Output banded symmetric matrix
+!!  \param k        Scalar coefficient
+!!  \param hbw      Half bandwidth of the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param expDat   Expected data contents
+!!
+!!  This test checks that scalar multiplication is performed correctly
+!!  when using the overloaded (*) operator.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_scal_mul_OP
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_scal_mul_OP'
+  TYPE(bandSymMatrixT) :: test1, test2
+  DOUBLE PRECISION, PARAMETER :: k=3.d0
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(hbw,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,3.d0,0.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0, &
+                    3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0, &
+                    3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0,3.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize input matrix
+  !! (loop sets bands to ones)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    DO j = i,MIN(i+hbw-1,n)
+      CALL bsm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> perform scalar multiplication
+  test2 = k * test1
+  CALL assertEquals(expDat,test2%dat, hbw,n)
+
+  !> clear output matrix
+  CALL bsm_clean(test2)
+
+  !> perform scalar multiplication (switch order of inputs)
+  test2 = test1 * k
+  CALL assertEquals(expDat,test2%dat, hbw,n)
+
+  !> deallocate matrices
+  CALL bsm_clean(test1)
+  CALL bsm_clean(test2)
+
+END SUBROUTINE test_bsm_scal_mul_OP
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception when performing matrix-vector multiplication
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Input banded symmetric matrix
+!!  \param test2      Input vector
+!!  \param test3      Dummy output vector
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!
+!!  This test checks that a DIMEN exception is raised when matrix-vector
+!!  multiplication is attempted with a vector whose length does not equal
+!!  the number of rows in the matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_vec_mul_DIMEN
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_vec_mul_DIMEN'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: hbw=3,n=10
+  INTEGER, PARAMETER :: expMsg=DIMEN
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> set up matrix and vector (data contents not important)
+  CALL bsm_init(test1, hbw,n)
+  CALL vec_init(test2, n+1)   !> note different size
+
+  !> attempt matrix-vector multiplication
+  test3 = bsm_vecMul(test1,test2, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate objects
+  CALL log_closeLogFile()
+  CALL bsm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_bsm_vec_mul_DIMEN
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct matrix-vector multiplication
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Input banded symmetric matrix
+!!  \param test2      Input vector
+!!  \param test3      Output vector
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-vector multiplication is performed
+!!  correctly in the general case (input matrix and vector contain data,
+!!  but it is not of a special form).
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_vec_mul_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_vec_mul_VAL'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    14.d0,  40.d0,  85.d0,  150.d0, 235.d0, &
+                    340.d0, 465.d0, 610.d0, 566.d0, 488.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize input matrix
+  !! (loop sets up data)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    DO j = i,MIN(i+hbw-1,n)
+      CALL bsm_set(test1, i,j, ( (DBLE(j)-1.d0) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize input vector
+  !! (loop sets up data)
+  CALL vec_init(test2, n)
+  DO i = 1,n
+    CALL vec_set(test2, i, DBLE(i))
+  END DO
+
+  !> perform multiplication
+  test3 = bsm_vecMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, n)
+
+  !> deallocate objects
+  CALL bsm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_bsm_vec_mul_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for matrix-vector multiplication (by the zero vector)
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Input banded symmetric matrix
+!!  \param test2      Input vector (zeros)
+!!  \param test3      Output vector
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-vector multiplication is performed
+!!  correctly when the input vector is all zeros.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_vec_mul_ZERO
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_vec_mul_ZERO'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0,0.d0 &
+                    /), SHAPE(expDat) )
+
+  !> initialize input matrix
+  !! (loop sets up data)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    DO j = i,MIN(i+hbw-1,n)
+      CALL bsm_set(test1, i,j, ( (DBLE(j)-1.d0) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize input vector (all zeros)
+  CALL vec_init(test2, n)
+
+  !> perform multiplication
+  test3 = bsm_vecMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, n)
+
+  !> deallocate objects
+  CALL bsm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_bsm_vec_mul_ZERO
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for matrix-vector multiplication (by the identity matrix)
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Input banded symmetric matrix (identity)
+!!  \param test2      Input vector
+!!  \param test3      Output vector
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-vector multiplication is performed
+!!  correctly when the input matrix is the identity for multiplication.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_vec_mul_IDENT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_vec_mul_IDENT'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize input matrix
+  !! (loop sets up identity matrix)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    CALL bsm_set(test1, i,i, 1.d0)
+  END DO
+
+  !> initialize input vector
+  !! (loop sets data)
+  CALL vec_init(test2, n)
+  DO i = 1,n
+    CALL vec_set(test2, i, DBLE(i))
+  END DO
+
+  !> expected result is the same as the initial vector
+  expDat = test2%dat
+
+  !> perform multiplication
+  test3 = bsm_vecMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, n)
+
+  !> deallocate objects
+  CALL bsm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_bsm_vec_mul_IDENT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct matrix-vector multiplication ( using OPERATOR (*) )
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1      Input banded symmetric matrix
+!!  \param test2      Input vector
+!!  \param test3      Output vector
+!!  \param hbw        Half bandwidth of the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-vector multiplication is performed
+!!  correctly in the general case (input matrix and vector contain data,
+!!  but it is not of a special form). The overloaded operator (*) is used.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bsm_vec_mul_OP
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bsm_vec_mul_OP'
+  TYPE(bandSymMatrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  INTEGER, PARAMETER :: hbw=3,n=10
+  DOUBLE PRECISION, DIMENSION(n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result (note: Fortran uses column-major storage)
+  expDat = RESHAPE( (/ &
+                    14.d0,  40.d0,  85.d0,  150.d0, 235.d0, &
+                    340.d0, 465.d0, 610.d0, 566.d0, 488.d0  &
+                    /), SHAPE(expDat) )
+
+  !> initialize input matrix
+  !! (loop sets data)
+  CALL bsm_init(test1, hbw,n)
+  DO i = 1,n
+    DO j = i,MIN(i+hbw-1,n)
+      CALL bsm_set(test1, i,j, ( (DBLE(j)-1.d0) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize input vector
+  !! (loop sets data)
+  CALL vec_init(test2, n)
+  DO i = 1,n
+    CALL vec_set(test2, i, DBLE(i))
+  END DO
+
+  !> perform multiplication
+  test3 = test1 * test2
+  CALL assertEquals(expDat,test3%dat, n)
+
+  !> deallocate objects
+  CALL bsm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_bsm_vec_mul_OP
+
+
+
+END MODULE band_sym_matrix_test

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/boundary_data.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module for Boundary Data
+! ------------------------------------------------------------------------
+MODULE boundary_data
+USE system_constants      !> Global system constants
+USE log_message_control   !> Printing log/error messages
+USE log_messages          !> Log/error message and sender codes
+USE field_data            !> Field Data module
+
+IMPLICIT NONE
+PRIVATE
+
+
+
+! ************************************************************************
+! EXPORTS
+! ************************************************************************
+
+
+!> Exported data types
+PUBLIC :: surfLoadT
+
+
+!> Exported interfaces
+PUBLIC :: bnd_init, bnd_clean, &
+          bnd_numBoundElem, &
+          bnd_getConnect, bnd_setConnect, &
+          bnd_lenBoundElem, &
+          bnd_getTrac, bnd_setTrac
+
+
+
+! ************************************************************************
+! LOCAL CONSTANTS
+! ************************************************************************
+
+!> sender code for this module
+INTEGER, PARAMETER :: sdr = BNDDAT
+
+
+
+! ************************************************************************
+! DATA TYPES
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Surface load
+!!
+!!  \param sig_nt   Shear stress
+!!  \param sig_nn   Normal stress
+! ------------------------------------------------------------------------
+TYPE surfLoadT
+  DOUBLE PRECISION :: sig_nt, sig_nn
+END TYPE surfLoadT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Surface traction
+!!
+!!  \param loads   Set of node loads
+! ------------------------------------------------------------------------
+TYPE tracT
+  TYPE(surfLoadT), DIMENSION(NNODELB) :: loads
+END TYPE tracT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Connectivity
+!!
+!!  \param nd   Sequence of node indices
+! ------------------------------------------------------------------------
+TYPE boundConnectT
+  INTEGER, DIMENSION(NNODELB) :: nd
+END TYPE boundConnectT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Traction Element
+!!
+!!  \param num      Element number
+!!  \param ico      Connectivity of local nodes
+!!  \param trac     Surface traction of element
+! ------------------------------------------------------------------------
+TYPE boundElementT
+  INTEGER             :: num
+  TYPE(boundConnectT) :: ico
+  TYPE(tracT)         :: trac
+END TYPE boundElementT
+
+
+
+! ************************************************************************
+! STATE VARIABLES
+! ************************************************************************
+
+TYPE(boundElementT), ALLOCATABLE :: boundElements(:)  !> set of traction elements
+
+
+
+! ************************************************************************
+! INTERFACES
+! ************************************************************************
+
+
+!> \brief Interface to initializer for boundary element data
+INTERFACE bnd_init
+  MODULE PROCEDURE bnd_init_
+  MODULE PROCEDURE bnd_init_exc_
+END INTERFACE bnd_init
+
+!> \brief Interface to destructor for boundary element data
+INTERFACE bnd_clean
+  MODULE PROCEDURE bnd_clean_
+END INTERFACE bnd_clean
+
+!> \brief Interface to getter for number of traction elements
+INTERFACE bnd_numBoundElem
+  MODULE PROCEDURE bnd_num_bound_elem_
+END INTERFACE bnd_numBoundElem
+
+!> \brief Interface to getter for traction element connectivity
+INTERFACE bnd_getConnect
+  MODULE PROCEDURE bnd_get_connect_
+  MODULE PROCEDURE bnd_get_connect_exc_
+END INTERFACE bnd_getConnect
+
+!> \brief Interface to setter for traction element connectivity
+INTERFACE bnd_setConnect
+  MODULE PROCEDURE bnd_set_connect_
+  MODULE PROCEDURE bnd_set_connect_exc_
+END INTERFACE bnd_setConnect
+
+!> \brief Interface to getter for length of traction element
+INTERFACE bnd_lenBoundElem
+  MODULE PROCEDURE bnd_len_bound_elem_
+  MODULE PROCEDURE bnd_len_bound_elem_exc_
+END INTERFACE bnd_lenBoundElem
+
+!> \brief Interface to getter for tractions
+INTERFACE bnd_getTrac
+  MODULE PROCEDURE bnd_get_trac_
+  MODULE PROCEDURE bnd_get_trac_exc_
+END INTERFACE bnd_getTrac
+
+!> \brief Interface to setter for tractions
+INTERFACE bnd_setTrac
+  MODULE PROCEDURE bnd_set_trac_
+  MODULE PROCEDURE bnd_set_trac_exc_
+END INTERFACE bnd_setTrac
+
+
+
+CONTAINS
+
+
+
+! ************************************************************************
+! ACCESS PROGRAMS
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for traction element data (non-exception checking)
+!!
+!!  \param  nel  Number of elements
+!!
+!!  This routine allocates memory and initializes the state variable that
+!!  contains the set of elements for the problem.
+! ------------------------------------------------------------------------
+SUBROUTINE bnd_init_ (nel)
+  INTEGER, INTENT(IN) :: nel
+  INTEGER :: i, j     !> loop variables
+
+  !> ensure state variable is clear
+  CALL bnd_clean()
+
+  !> allocate memory for element data state variable
+  ALLOCATE(boundElements(nel))
+
+  !> initialize state variable
+  DO i = 1,nel
+
+    !> element number
+    boundElements(i)%num   = i
+
+    !> initialize connectivity and loads
+    DO j = 1,NNODELB
+      boundElements(i)%ico  %nd(j)            = 0
+      boundElements(i)%trac %loads(j) %sig_nt = 0.d0
+      boundElements(i)%trac %loads(j) %sig_nn = 0.d0
+    END DO
+
+  END DO
+
+END SUBROUTINE bnd_init_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for traction element data (exception checking)
+!!
+!!  \param  nel   Number of elements
+!!  \param  exc   Error code
+!!
+!!  \exception  ALLOC Failed to allocate memory for element data
+!!  \exception  SZE   Specified number of elements is invalid
+!!
+!!  This routine allocates memory and initializes the state variable that
+!!  contains the set of elements for the problem.
+! ------------------------------------------------------------------------
+SUBROUTINE bnd_init_exc_ (nel, exc)
+  INTEGER, INTENT(IN) :: nel
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: e        !> status code for memory allocation
+  INTEGER :: i, j     !> loop variables
+
+  !> ensure state variable is clear
+  CALL bnd_clean()
+
+  !> make sure number of elements is valid
+  IF (nel.LT.1 .OR. nel.GT.MAX_BOUNDELS) THEN
+    exc=SZE
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> allocate memory for element data state variable
+  ALLOCATE(boundElements(nel), STAT=e)
+
+  !> make sure memory allocation was successful
+  IF (e.NE.0) THEN
+    exc=ALLOC
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> initialize state variable
+  DO i = 1,nel
+
+    !> element number
+    boundElements(i)%num   = i
+
+    !> initialize connectivity and loads
+    DO j = 1,NNODELB
+      boundElements(i)%ico  %nd(j)            = 0
+      boundElements(i)%trac %loads(j) %sig_nt = 0.d0
+      boundElements(i)%trac %loads(j) %sig_nn = 0.d0
+    END DO
+
+  END DO
+
+END SUBROUTINE bnd_init_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Destructor for traction element data
+!!
+!!  This routine clears the memory allocated to the state variable that
+!!  contains the set of element data for the problem.
+! ------------------------------------------------------------------------
+SUBROUTINE bnd_clean_ ()
+
+  IF (ALLOCATED(boundElements)) DEALLOCATE(boundElements)
+
+END SUBROUTINE bnd_clean_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for number of traction elements
+!!
+!!  \return nel  Number of elements
+!!
+!!  This routine determines the number of data entries that have been
+!!  allocated for element data. It does not check that the element data
+!!  has been populated (i.e. changed from initial zero values).
+! ------------------------------------------------------------------------
+FUNCTION bnd_num_bound_elem_ () RESULT(nel)
+  INTEGER :: nel
+
+  !> if data is initialized, return number of elements
+  IF (ALLOCATED(boundElements)) THEN
+    nel = SIZE(boundElements)
+  ELSE
+    nel = 0   !> if not initialized, there are no traction elements
+  END IF
+
+END FUNCTION bnd_num_bound_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for connectivity (non-exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Local node index
+!!
+!!  \return n     Global node number
+!!
+!!  This routine determines the global node number associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+FUNCTION bnd_get_connect_ (i,j) RESULT(n)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER :: n
+
+  n = boundElements(i)%ico%nd(j)
+
+END FUNCTION bnd_get_connect_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for connectivity (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  exc   Error code
+!!
+!!  \return n     Global node number
+!!
+!!  \exception  POSIT The element number is not in [1..bnd_numBoundElem()]
+!!                    or the local node index is not in [1..NNODELB]
+!!
+!!  This routine determines the global node number associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+FUNCTION bnd_get_connect_exc_ (i,j, exc) RESULT(n)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: n
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the local node index is within [1..NNODELB]
+  IF ( i.LT.1 .OR. i.GT.bnd_numBoundElem() &
+        .OR. j.LT.1 .OR. j.GT.NNODELB ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    n = 0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  n = bnd_getConnect(i,j)
+
+END FUNCTION bnd_get_connect_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for connectivity (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  n     Global node number
+!!
+!!  This routine sets the global node number associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+SUBROUTINE bnd_set_connect_ (i,j, n)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(IN) :: n
+
+  boundElements(i)%ico%nd(j) = n
+
+END SUBROUTINE bnd_set_connect_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for connectivity (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  n     Global node number
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the node number exceeds the number of
+!!                      nodes
+!!  \exception  POSIT   The element number is not in
+!!                      [1..bnd_numBoundElem()] or the local node index is
+!!                      not in [1..NNODELB]
+!!
+!!  This routine sets the global node number associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+SUBROUTINE bnd_set_connect_exc_ (i,j, n, exc)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(IN) :: n
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the local node index is within [1..NNODELB]
+  IF ( i.LT.1 .OR. i.GT.bnd_numBoundElem() &
+        .OR. j.LT.1 .OR. j.GT.NNODELB ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (n.LT.1 .OR. n.GT.fld_numNode()) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL bnd_setConnect(i,j, n)
+
+END SUBROUTINE bnd_set_connect_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Compute the length of an element (non-exception checking)
+!!
+!!  \param  i       Element number
+!!
+!!  \return length  Volume of element
+!!
+!!  This routine computes the length of a traction element. This is
+!!  computed as:
+!!
+!!    L   =  ( (y2-y1)**2 + (x2-x1)**2 )**0.5
+!!
+!!  where xj and yj are the (x,y) coordinates of node j of element i.
+! ------------------------------------------------------------------------
+FUNCTION bnd_len_bound_elem_ (i) RESULT(length)
+  INTEGER, INTENT(IN) :: i
+  DOUBLE PRECISION :: length
+  DOUBLE PRECISION, DIMENSION(NNODELB,NDIM) :: x  !> element coords
+  INTEGER :: j,k    !> loop variable
+
+  !> get element coords
+  DO k = 1,NDIM
+    DO j = 1,NNODELB
+      x(j,k) = fld_getCoord(boundElements(i)%ico%nd(j), k)
+    END DO
+  END DO
+
+  !> compute length
+  length = SQRT( (x(2,2)-x(1,2))**2 + (x(2,1)-x(1,1))**2 )
+
+END FUNCTION bnd_len_bound_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Compute the length of an element (exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  exc   Error code
+!!
+!!  \return length   Length of element
+!!
+!!  \exception  POSIT   The specified element number is not within the
+!!                      range [1..bnd_numBoundElem()]
+!!
+!!  This routine computes the length of a traction element. This is
+!!  computed as:
+!!
+!!    L   =  ( (y2-y1)**2 + (x2-x1)**2 )**0.5
+!!
+!!  where xj and yj are the (x,y) coordinates of node j of element i.
+! ------------------------------------------------------------------------
+FUNCTION bnd_len_bound_elem_exc_ (i, exc) RESULT(length)
+  INTEGER, INTENT(IN) :: i
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: length
+
+  !> make sure the element number is valid
+  IF (i.LT.1 .OR. i.GT.bnd_numBoundElem()) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    length = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  length = bnd_lenBoundElem(i)
+
+END FUNCTION bnd_len_bound_elem_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for traction (non-exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Local node index
+!!
+!!  \return load  Surface load
+!!
+!!  This routine determines the surface load associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+FUNCTION bnd_get_trac_ (i,j) RESULT(load)
+  INTEGER, INTENT(IN) :: i,j
+  TYPE(surfLoadT) :: load
+
+  load%sig_nt = boundElements(i)%trac%loads(j)%sig_nt
+  load%sig_nn = boundElements(i)%trac%loads(j)%sig_nn
+
+END FUNCTION bnd_get_trac_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for traction (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  exc   Error code
+!!
+!!  \return load  Surface load
+!!
+!!  \exception  POSIT The element number is not in [1..bnd_numBoundElem()]
+!!                    or the local node index is not in [1..NNODELB]
+!!
+!!  This routine determines the surface load associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+FUNCTION bnd_get_trac_exc_ (i,j, exc) RESULT(load)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  TYPE(surfLoadT) :: load
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the local node index is within [1..NNODELB]
+  IF ( i.LT.1 .OR. i.GT.bnd_numBoundElem() &
+        .OR. j.LT.1 .OR. j.GT.NNODELB ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    load%sig_nt = 0.d0
+    load%sig_nn = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  load = bnd_getTrac(i,j)
+
+END FUNCTION bnd_get_trac_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for traction (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  load  Surface load
+!!
+!!  This routine sets the surface load associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+SUBROUTINE bnd_set_trac_ (i,j, load)
+  INTEGER, INTENT(IN) :: i,j
+  TYPE(surfLoadT), INTENT(IN) :: load
+
+  boundElements(i)%trac%loads(j)%sig_nt = load%sig_nt
+  boundElements(i)%trac%loads(j)%sig_nn = load%sig_nn
+
+END SUBROUTINE bnd_set_trac_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for traction (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  load  Surface load
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  A value in the set of surface load stress is not
+!!                      within the specified limits
+!!  \exception  POSIT   The element number is not in
+!!                      [1..bnd_numBoundElem()] or the local node index is
+!!                      not in [1..NNODELB]
+!!
+!!  This routine sets the surface load associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+SUBROUTINE bnd_set_trac_exc_ (i,j, load, exc)
+  INTEGER, INTENT(IN) :: i,j
+  TYPE(surfLoadT), INTENT(IN) :: load
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the local node index is within [1..NNODELB]
+  IF ( i.LT.1 .OR. i.GT.bnd_numBoundElem() &
+        .OR. j.LT.1 .OR. j.GT.NNODELB ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF ( load%sig_nt.LT.SIG_MIN .OR. load%sig_nt.GT.SIG_MAX &
+            .OR. load%sig_nn.LT.SIG_MIN .OR. load%sig_nn.GT.SIG_MAX ) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL bnd_setTrac(i,j, load)
+
+END SUBROUTINE bnd_set_trac_exc_
+
+
+
+! ************************************************************************
+! LOCAL FUNCTIONS
+! ************************************************************************
+
+! none
+
+END MODULE boundary_data

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/boundary_data_test.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module for testing Boundary Data module
+! ------------------------------------------------------------------------
+MODULE boundary_data_test
+USE fruit                   !> Unit testing framework
+USE system_constants        !> Global constants
+USE log_message_control     !> Printing log/error messages
+USE log_messages            !> Log/error codes
+USE field_data              !> Field Data module
+USE boundary_data           !> Boundary Data module
+
+IMPLICIT NONE
+
+
+CONTAINS
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for OK exception message on allocation of elements
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param nel        Number of elements
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!
+!!  This test initializes the elements state variable in the boundary_data
+!!  module and makes sure that the exception message is OK
+!!  (i.e. allocation did not fail).
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_elem_allocation_MSG
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_elem_allocation_MSG'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: expMsg=OK
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log message file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize module and check the exception
+  CALL bnd_init(nel, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate module
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_elem_allocation_MSG
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for SZE exception message on allocation of traction elements
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!
+!!  This test attempts to initialize the elements state variable in the
+!!  boundary data module with invalid size parameters and verifies that
+!!  the correct exception is returned.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_elem_allocation_SZE
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_elem_allocation_SZE'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: expMsg=SZE
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> try to initialize with nel=0
+  CALL bnd_init(0, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> ensure module is reset
+  CALL bnd_clean()
+
+  !> try to initialize with nel=MAX_BOUNDELS+1
+  CALL bnd_init(MAX_BOUNDELS+1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate module
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_elem_allocation_SZE
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for number of elements when element data is not initialized
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param expected     Expected number of elements
+!!  \param actual       Actual number of elements
+!!
+!!  This test makes sure that the number of elements is returned as 0
+!!  when the element data is not initialized
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_num_elem_not_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_num_elem_not_allocated'
+  INTEGER, PARAMETER :: expected = 0
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> check number of materials
+  actual = bnd_numBoundElem()
+  CALL assertEquals(expected, actual)
+
+END SUBROUTINE test_bnd_num_elem_not_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for number of elements when element data is initialized
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param expected     Expected number of elements
+!!  \param actual       Actual number of elements
+!!
+!!  This test makes sure that the correct number of elements is returned.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_num_elem_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_num_elem_allocated'
+  INTEGER, PARAMETER :: expected = 100
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the module
+  CALL bnd_init(expected)
+
+  !> check number of nodes
+  actual = bnd_numBoundElem()
+  CALL assertEquals(expected, actual)
+
+  !> deallocate the module
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_num_elem_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception from bnd_getConnect
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param jnod       Local node index
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!  \param n          Dummy variable for get function return
+!!
+!!  This test checks that a POSIT exception is returned when the requested
+!!  location is not inside the element list or the requested local node
+!!  index is not within [1..NNODELB].
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_get_connect_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_get_connect_POSIT'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: iel = 50
+  INTEGER, PARAMETER :: jnod = 2
+  INTEGER, PARAMETER :: expMsg = POSIT
+  INTEGER :: actMsg
+  INTEGER :: n
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize nodes
+  CALL bnd_init(nel)
+
+  !> try to get beyond last element
+  n = bnd_getConnect(nel+1,jnod, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first element
+  n = bnd_getConnect(0,jnod, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get beyond last local node index
+  n = bnd_getConnect(iel,NNODELB+1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first local node index
+  n = bnd_getConnect(iel,0, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate the elements list
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_get_connect_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception from bnd_setConnect
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param nnod       Number of nodes
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param jnod       Local node index
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!  \param n          Dummy variable for set routine input
+!!
+!!  This test checks that a POSIT exception is returned when the requested
+!!  location is not inside the element list or the requested local node
+!!  index is not within [1..NNODELB].
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_set_connect_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_set_connect_POSIT'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: nnod=100
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: iel = 50
+  INTEGER, PARAMETER :: jnod = 2
+  INTEGER, PARAMETER :: expMsg = POSIT
+  INTEGER :: actMsg
+  INTEGER, PARAMETER :: n = 10
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize nodes and elements
+  CALL bnd_init(nel)
+
+  !> try to set beyond last element
+  CALL bnd_setConnect(nel+1,jnod, n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set before first element
+  CALL bnd_setConnect(0,jnod, n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set beyond last local node index
+  CALL bnd_setConnect(iel,NNODELB+1, n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set before first local node index
+  CALL bnd_setConnect(iel,0, n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate elements
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_set_connect_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for EXCEED exception from bnd_setConnect
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param nnod       Number of nodes
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param jnod       Local node index
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!
+!!  This test checks that an EXCEED exception is returned when the
+!!  specified input is not within the range defined in the System
+!!  Constants module.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_set_connect_EXCEED
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_set_connect_EXCEED'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: nnod=100
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: iel = 50
+  INTEGER, PARAMETER :: jnod = 2
+  INTEGER, PARAMETER :: expMsg = EXCEED
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize nodes and elements
+  CALL fld_initNode(nnod)
+  CALL bnd_init(nel)
+
+  !> try to set below minimum
+  CALL bnd_setConnect(iel,jnod, 0, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set above maximum
+  CALL bnd_setConnect(iel,jnod, nnod+1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate the nodes and elements
+  CALL log_closeLogFile()
+  CALL fld_cleanNode()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_set_connect_EXCEED
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct value getting and setting in bnd_getConnect
+!!        and bnd_setConnect
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param nnod       Number of nodes
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param jnod       Local node index
+!!  \param expVal     Expected data value
+!!  \param actVal     Actual data value
+!!
+!!  This test checks that the correct value is set using the
+!!  bnd_setConnect access program and returned from the
+!!  bnd_getConnect access program.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_get_set_connect_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_get_set_connect_VAL'
+  INTEGER, PARAMETER :: nnod=100
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: iel = 50
+  INTEGER, PARAMETER :: jnod = 2
+  INTEGER, PARAMETER :: expVal = 20
+  INTEGER :: actVal
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize nodes and elements
+  CALL fld_initNode(nnod)
+  CALL bnd_init(nel)
+
+  !> set connectivity value
+  CALL bnd_setConnect(iel,jnod, expVal)
+  actVal = bnd_getConnect(iel,jnod)
+  CALL assertEquals(expVal,actVal)
+
+  !> finalize the log file and deallocate the nodes and elements
+  CALL log_closeLogFile()
+  CALL fld_cleanNode()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_get_set_connect_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception message from bnd_lenBoundElem
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param nel        Number of elements
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!  \param length     Dummy variable for get function return
+!!
+!!  This test makes sure that the correct exception is returned when the
+!!  specified element index is not in the range of the allocated element
+!!  data.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_len_bound_elem_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_len_bound_elem_POSIT'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: expMsg=POSIT
+  INTEGER :: actMsg
+  DOUBLE PRECISION :: length
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize elements
+  CALL bnd_init(nel)
+
+  !> try to get beyond last element
+  length = bnd_lenBoundElem(nel+1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first element
+  length = bnd_lenBoundElem(0, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate the elements list
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_len_bound_elem_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for element length when node coordinates not initialized
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param nnod       Number of nodes
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param expected   Expected length of element (zero)
+!!  \param actual     Actual length of element
+!!
+!!  This test makes sure that the length of the element is returned as 0
+!!  when the coordinates of the connected nodes have not been set
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_len_bound_elem_ZERO
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_len_bound_elem_ZERO'
+  INTEGER, PARAMETER :: nnod=100
+  INTEGER, PARAMETER :: nel=100
+  DOUBLE PRECISION, PARAMETER :: expected = 0.d0
+  DOUBLE PRECISION :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize nodes and elements
+  CALL fld_initNode(nnod)
+  CALL bnd_init(nel)
+
+  !> set connectivity of first element to {1,2}
+  CALL bnd_setConnect(1,1,1)
+  CALL bnd_setConnect(1,2,2)
+
+  !> check length of element
+  actual = bnd_lenBoundElem(1)
+  CALL assertEquals(expected,actual)
+
+  !> deallocate the elements and nodes
+  CALL fld_cleanNode()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_len_bound_elem_ZERO
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for element length when node coordinates initialized
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param nnod       Number of nodes
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param expected   Expected length of element
+!!  \param actual     Actual length of element
+!!
+!!  This test makes sure that the length of the element is computed
+!!  correctly for the line given by (1,1), (3,2)
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_len_bound_elem_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_len_bound_elem_VAL'
+  INTEGER, PARAMETER :: nnod=100
+  INTEGER, PARAMETER :: nel=100
+  DOUBLE PRECISION, PARAMETER :: toler = 1.d-14
+  DOUBLE PRECISION, PARAMETER :: expected = 2.23606797749979d0
+  DOUBLE PRECISION :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize nodes and elements
+  CALL fld_initNode(nnod)
+  CALL bnd_init(nel)
+
+  !> set connectivity of first element to {1,2}
+  CALL bnd_setConnect(1,1,1)
+  CALL bnd_setConnect(1,2,2)
+
+  !> set coordinates of nodes
+  CALL fld_setCoord(1,1, 1.d0)
+  CALL fld_setCoord(1,2, 1.d0)
+  CALL fld_setCoord(2,1, 3.d0)
+  CALL fld_setCoord(2,2, 2.d0)
+
+  !> check volume of element
+  actual = bnd_lenBoundElem(1)
+  CALL assertEquals(expected,actual, toler)
+
+  !> deallocate the elements and nodes
+  CALL fld_cleanNode()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_len_bound_elem_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception from bnd_getTrac
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param jnod       Local node index
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!  \param load       Dummy variable for get function return
+!!
+!!  This test checks that a POSIT exception is returned when the requested
+!!  location is not inside the element list or the requested local node
+!!  index is not within [1..NNODELB].
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_get_trac_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_get_trac_POSIT'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: iel = 50
+  INTEGER, PARAMETER :: jnod = 2
+  INTEGER, PARAMETER :: expMsg = POSIT
+  INTEGER :: actMsg
+  TYPE(surfLoadT) :: load
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize nodes
+  CALL bnd_init(nel)
+
+  !> try to get beyond last element
+  load = bnd_getTrac(nel+1,jnod, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first element
+  load = bnd_getTrac(0,jnod, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get beyond last local node index
+  load = bnd_getTrac(iel,NNODELB+1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first local node index
+  load = bnd_getTrac(iel,0, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate the elements list
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_get_trac_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception from bnd_setTrac
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param nnod       Number of nodes
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param jnod       Local node index
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!  \param load       Dummy variable for set routine input
+!!
+!!  This test checks that a POSIT exception is returned when the requested
+!!  location is not inside the element list or the requested local node
+!!  index is not within [1..NNODELB].
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_set_trac_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_set_trac_POSIT'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: nnod=100
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: iel = 50
+  INTEGER, PARAMETER :: jnod = 2
+  INTEGER, PARAMETER :: expMsg = POSIT
+  INTEGER :: actMsg
+  TYPE(surfLoadT) :: load
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize elements
+  CALL bnd_init(nel)
+
+  !> try to set beyond last element
+  CALL bnd_setTrac(nel+1,jnod, load, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set before first element
+  CALL bnd_setTrac(0,jnod, load, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set beyond last local node index
+  CALL bnd_setTrac(iel,NNODELB+1, load, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set before first local node index
+  CALL bnd_setTrac(iel,0, load, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate the nodes and elements
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_set_trac_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for EXCEED exception from bnd_setTrac
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param jnod       Local node index
+!!  \param sig_nt     Test shear stress
+!!  \param sig_nn     Test normal stress
+!!  \param load       Surface load
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!
+!!  This test checks that an EXCEED exception is returned when the
+!!  specified input is not within the range defined in the System
+!!  Constants module.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_set_trac_EXCEED
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_set_trac_EXCEED'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: iel = 50
+  INTEGER, PARAMETER :: jnod = 2
+  DOUBLE PRECISION :: sig_nt, sig_nn
+  TYPE(surfLoadT) :: load
+  INTEGER, PARAMETER :: expMsg = EXCEED
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize elements
+  CALL bnd_init(nel)
+
+  !> set load such that sig_nt < SIG_MIN
+  sig_nt = SIG_MIN-0.1d0
+  sig_nn = 0.d0
+  load%sig_nt = sig_nt
+  load%sig_nn = sig_nn
+
+  !> try to set traction
+  CALL bnd_setTrac(iel,jnod, load, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> set load such that sig_nt > SIG_MAX
+  sig_nt = SIG_MAX+0.1d0
+  load%sig_nt = sig_nt
+
+  !> try to set traction
+  CALL bnd_setTrac(iel,jnod, load, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> set load such that sig_nn < SIG_MIN
+  sig_nt = 0.d0
+  sig_nn = SIG_MIN-0.1d0
+  load%sig_nt = sig_nt
+  load%sig_nn = sig_nn
+
+  !> try to set traction
+  CALL bnd_setTrac(iel,jnod, load, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> set load such that sig_nn > SIG_MAX
+  sig_nn = SIG_MAX+0.1d0
+  load%sig_nn = sig_nn
+
+  !> try to set traction
+  CALL bnd_setTrac(iel,jnod, load, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate elements
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_set_trac_EXCEED
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct value getting and setting in bnd_getTrac
+!!        and bnd_setTrac
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param nel        Number of elements
+!!  \param iel        Element number
+!!  \param jnod       Local node index
+!!  \param load       Surface load
+!!  \param expSigNT   Expected shear stress
+!!  \param expSigNN   Expected normal stress
+!!  \param actSigNT   Actual shear stress
+!!  \param actSigNN   Actual normal stress
+!!
+!!  This test checks that the correct value is set using the
+!!  bnd_setTrac access program and returned from the
+!!  bnd_getTrac access program.
+! ------------------------------------------------------------------------
+SUBROUTINE test_bnd_get_set_trac_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_bnd_get_set_trac_VAL'
+  INTEGER, PARAMETER :: nnod=100
+  INTEGER, PARAMETER :: nel=100
+  INTEGER, PARAMETER :: iel = 50
+  INTEGER, PARAMETER :: jnod = 2
+  DOUBLE PRECISION, PARAMETER :: expSigNT=1.d3, expSigNN=-2.d3
+  TYPE(surfLoadT) :: load
+  DOUBLE PRECISION :: actSigNT, actSigNN
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize elements
+  CALL bnd_init(nel)
+
+  !> set traction value
+  load%sig_nt = expSigNT
+  load%sig_nn = expSigNN
+  CALL bnd_setTrac(iel,jnod, load)
+
+  !> reset load
+  load%sig_nt = 0.d0
+  load%sig_nn = 0.d0
+
+  !> get traction value
+  load = bnd_getTrac(iel,jnod)
+  actSigNT = load%sig_nt
+  actSigNN = load%sig_nn
+  CALL assertEquals(expSigNT,actSigNT)
+  CALL assertEquals(expSigNN,actSigNN)
+
+  !> finalize the log file and deallocate the nodes and elements
+  CALL log_closeLogFile()
+  CALL bnd_clean()
+
+END SUBROUTINE test_bnd_get_set_trac_VAL
+
+END MODULE boundary_data_test

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/constitutive.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module for Constitutive Matrix
+! ------------------------------------------------------------------------
+MODULE constitutive
+USE system_constants    !> Global constants (for size of matrix)
+USE log_message_control !> Printing log/error messages
+USE log_messages        !> Log/error codes
+USE dense_matrix_def    !> Dense Matrix data type
+
+IMPLICIT NONE
+PRIVATE
+
+
+
+! ************************************************************************
+! EXPORTS
+! ************************************************************************
+
+
+!> Exported interfaces
+PUBLIC :: dmatrix
+
+
+
+! ************************************************************************
+! LOCAL CONSTANTS
+! ************************************************************************
+
+INTEGER, PARAMETER :: sdr=CNSMAT
+
+
+! ************************************************************************
+! DATA TYPES
+! ************************************************************************
+
+! none
+
+
+
+! ************************************************************************
+! INTERFACES
+! ************************************************************************
+
+
+!> \brief Interface to constitutive matrix access program
+INTERFACE dmatrix
+  MODULE PROCEDURE dmatrix_linear_elastic_plane_strain_
+  MODULE PROCEDURE dmatrix_linear_elastic_plane_strain_exc_
+END INTERFACE dmatrix
+
+
+
+CONTAINS
+
+
+
+! ************************************************************************
+! ACCESS PROGRAMS
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constitutive matrix (linear elastic, plane strain)
+!!
+!!  \param  emod  Elastic modulus
+!!  \param  nu    Poisson's ratio
+!!  \param  Dmat  Constitutive matrix
+!!
+!!  This routine builds the constitutive matrix for a linear elastic
+!!  material under plane strain conditions. The matrix has the following
+!!  form:
+!!
+!!    D = ( emod / ((1+nu)*(1-2*nu)) ) * [ 1-nu   nu        0       ]
+!!                                       [  nu   1-nu       0       ]
+!!                                       [   0     0   0.5*(1-2*v)  ]
+! ------------------------------------------------------------------------
+SUBROUTINE dmatrix_linear_elastic_plane_strain_ (emod,nu, Dmat)
+  DOUBLE PRECISION, INTENT(IN) :: emod,nu
+  TYPE(matrixT), INTENT(INOUT) :: Dmat
+  DOUBLE PRECISION :: one_minus_nu, one_minus_two_nu, coef
+
+  one_minus_nu = 1.d0 - nu
+  one_minus_two_nu = 1.d0 - 2.d0*nu
+  coef = emod / ((1.d0+nu)*one_minus_two_nu)
+
+  CALL dm_init(Dmat, NTNS,NTNS)
+
+  CALL dm_set(Dmat, 1,1, coef*one_minus_nu)
+  CALL dm_set(Dmat, 2,1, coef*nu)
+  CALL dm_set(Dmat, 1,2, dm_get(Dmat, 2,1))
+  CALL dm_set(Dmat, 2,2, dm_get(Dmat, 1,1))
+  CALL dm_set(Dmat, 3,3, 0.5d0*coef*one_minus_two_nu)
+
+END SUBROUTINE dmatrix_linear_elastic_plane_strain_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constitutive matrix (linear elastic, plane strain)
+!!
+!!  \param  emod  Elastic modulus
+!!  \param  nu    Poisson's ratio
+!!  \param  Dmat  Constitutive matrix
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The specified values of elastic modulus or
+!!                      Poisson's ratio are not within specified limits
+!!
+!!  This routine builds the constitutive matrix for a linear elastic
+!!  material under plane strain conditions. The matrix has the following
+!!  form:
+!!
+!!    D = ( emod / ((1+nu)*(1-2*nu)) ) * [ 1-nu   nu        0       ]
+!!                                       [  nu   1-nu       0       ]
+!!                                       [   0     0   0.5*(1-2*v)  ]
+! ------------------------------------------------------------------------
+SUBROUTINE dmatrix_linear_elastic_plane_strain_exc_ (emod,nu, Dmat, exc)
+  DOUBLE PRECISION, INTENT(IN) :: emod,nu
+  TYPE(matrixT), INTENT(INOUT) :: Dmat
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: one_minus_nu, one_minus_two_nu, coef
+
+  !> check that specified parameters are within limits
+  IF (  emod.LT.E_MIN .OR. emod.GT.E_MAX  &
+        .OR. nu.LT.NU_MIN .OR. nu.GT.NU_MAX ) THEN
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL dmatrix(emod,nu, Dmat)
+
+END SUBROUTINE dmatrix_linear_elastic_plane_strain_exc_
+
+
+
+! ************************************************************************
+! LOCAL FUNCTIONS
+! ************************************************************************
+
+! none
+
+END MODULE constitutive

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/constitutive_test.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module for testing Constitutive Matrix module
+! ------------------------------------------------------------------------
+MODULE constitutive_test
+USE fruit                   !> Unit testing framework
+USE system_constants        !> Global system constants
+USE log_message_control     !> Printing log/error messages
+USE log_messages            !> Log/error message and sender codes
+USE dense_matrix_def        !> Dense Matrix ADT
+USE constitutive            !> Constitutive Matrix module
+
+IMPLICIT NONE
+
+
+CONTAINS
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for EXCEED exception from dmatrix
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param emod       Non-exceeding elastic modulus
+!!  \param nu         Non-exceeding Poisson's ratio
+!!  \param emod1      Test elastic modulus 1 ( = E_MIN-0.1 < E_MIN )
+!!  \param nu1        Test Poisson's ratio 1 ( = NU_MIN-0.1 < NU_MIN )
+!!  \param emod1      Test elastic modulus 2 ( = EMAX+1.0 > E_MAX )
+!!  \param nu1        Test Poisson's ratio 2 ( = 0.5 > NU_MAX )
+!!  \param expMsg     Expected log message
+!!  \param actMsg     Actual log message
+!!  \param Dmat       Dummy matrix for dmatrix output
+!!
+!!  This test attempts to obtain the constitutive matrix for values that
+!!  are outside the specified range and ensures that the correct exception
+!!  is raised.
+! ------------------------------------------------------------------------
+SUBROUTINE test_constitutive_EXCEED
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_constitutive_EXCEED'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  DOUBLE PRECISION, PARAMETER :: emod = 70.d3, nu = 0.3d0
+  DOUBLE PRECISION, PARAMETER :: emod1 = E_MIN-0.1d0
+  DOUBLE PRECISION, PARAMETER :: nu1 = NU_MIN-0.1d0
+  DOUBLE PRECISION, PARAMETER :: emod2 = E_MAX+1.d0
+  DOUBLE PRECISION, PARAMETER :: nu2 = 0.5d0
+  INTEGER, PARAMETER :: expMsg=EXCEED
+  INTEGER :: actMsg
+  TYPE(matrixT) :: Dmat
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log message file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> try to call with low elastic modulus
+  CALL dmatrix(emod1,nu, Dmat, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to call with high elastic modulus
+  CALL dmatrix(emod2,nu, Dmat, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to call with low Poisson's ratio
+  CALL dmatrix(emod,nu1, Dmat, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to call with high Poisson's ratio
+  CALL dmatrix(emod,nu2, Dmat, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate D matrix
+  CALL log_closeLogFile()
+  CALL dm_clean(Dmat)
+
+END SUBROUTINE test_constitutive_EXCEED
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for dmatrix when elastic modulus is zero
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param emod       Elastic modulus ( = 0 )
+!!  \param nu         Poisson's ratio
+!!  \param expDat     Expected constitutive matrix (zeros)
+!!  \param Dmat       Matrix for dmatrix output
+!!
+!!  This test obtains the constitutive matrix when elastic modulus is
+!!  zero and Poisson's ratio is any value within the system defined
+!!  limits. It should be all zeros.
+! ------------------------------------------------------------------------
+SUBROUTINE test_constitutive_ZERO
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_constitutive_ZERO'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  DOUBLE PRECISION, PARAMETER :: emod = 0.d0
+  DOUBLE PRECISION, PARAMETER :: nu = 0.3d0
+  DOUBLE PRECISION, DIMENSION(NTNS,NTNS) :: expDat
+  TYPE(matrixT) :: Dmat
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result
+  expDat = RESHAPE( (/ &
+                    0.d0, 0.d0, 0.d0, &
+                    0.d0, 0.d0, 0.d0, &
+                    0.d0, 0.d0, 0.d0  &
+                    /), SHAPE(expDat) )
+
+  !> get constitutive matrix
+  CALL dmatrix(emod,nu, Dmat)
+  CALL assertEquals(expDat, Dmat%dat, NTNS,NTNS)
+
+  !> deallocate constitutive matrix
+  CALL dm_clean(Dmat)
+
+END SUBROUTINE test_constitutive_ZERO
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for dmatrix when parameters are in normal range
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param emod       Elastic modulus
+!!  \param nu         Poisson's ratio
+!!  \param toler      Tolerance on output
+!!  \param expDat     Expected constitutive matrix
+!!  \param Dmat       Matrix for dmatrix output
+!!
+!!  This test obtains the constitutive matrix when elastic modulus
+!!  and Poisson's ratio are given values within the system defined
+!!  limits.
+! ------------------------------------------------------------------------
+SUBROUTINE test_constitutive_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_constitutive_VAL'
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  DOUBLE PRECISION, PARAMETER :: emod = 70.d3
+  DOUBLE PRECISION, PARAMETER :: nu = 0.3d0
+  DOUBLE PRECISION, PARAMETER :: toler = 1.d-9
+  DOUBLE PRECISION, DIMENSION(NTNS,NTNS) :: expDat
+  TYPE(matrixT) :: Dmat
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result
+  expDat = RESHAPE( (/ &
+                    94230.7692307692d0, 40384.6153846154d0, 0.d0, &
+                    40384.6153846154d0, 94230.7692307692d0, 0.d0, &
+                    0.d0, 0.d0, 26923.0769230769d0 &
+                    /), SHAPE(expDat) )
+
+  !> get constitutive matrix
+  CALL dmatrix(emod,nu, Dmat)
+  CALL assertEquals(expDat, Dmat%dat, NTNS,NTNS, toler)
+
+  !> deallocate constitutive matrix
+  CALL dm_clean(Dmat)
+
+END SUBROUTINE test_constitutive_VAL
+
+END MODULE constitutive_test

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/dense_matrix_def.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module defining Dense Matrix data type
+! ------------------------------------------------------------------------
+MODULE dense_matrix_def
+USE log_message_control !> Print log/error messages
+USE log_messages        !> Log/error codes
+USE vector_def          !> Vector data type
+
+IMPLICIT NONE
+PRIVATE
+
+
+
+! ************************************************************************
+! EXPORTS
+! ************************************************************************
+
+
+!> Exported data types
+PUBLIC :: matrixT
+
+!> Exported interfaces
+PUBLIC :: dm_init, dm_clean, &
+          dm_numRows, dm_numCols, &
+          dm_get, dm_set, &
+          dm_add, OPERATOR (+), &
+          dm_scalMul, dm_vecMul, dm_matMul, OPERATOR (*), &
+          dm_transpose
+
+
+
+! ************************************************************************
+! LOCAL CONSTANTS
+! ************************************************************************
+
+
+!> Sender code for DeNSe MATrix module
+INTEGER, PARAMETER :: sdr = DNSMAT
+
+
+
+! ************************************************************************
+! DATA TYPES
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Dense Matrix ADT structure
+!!
+!!  \param dat  Array to store matrix data
+! ------------------------------------------------------------------------
+TYPE matrixT
+  DOUBLE PRECISION, ALLOCATABLE :: dat(:,:)
+END TYPE matrixT
+
+
+
+! ************************************************************************
+! INTERFACES
+! ************************************************************************
+
+
+!>  \brief Interface to constructor
+INTERFACE dm_init
+  MODULE PROCEDURE dm_init_
+  MODULE PROCEDURE dm_init_exc_
+END INTERFACE dm_init
+
+!>  \brief Interface to destructor
+INTERFACE dm_clean
+  MODULE PROCEDURE dm_clean_
+END INTERFACE dm_clean
+
+!>  \brief Interface to number of rows
+INTERFACE dm_numRows
+  MODULE PROCEDURE dm_num_rows_
+END INTERFACE dm_numRows
+
+!>  \brief Interface to number of columns
+INTERFACE dm_numCols
+  MODULE PROCEDURE dm_num_cols_
+END INTERFACE dm_numCols
+
+!>  \brief Interface to getter for individual entries in matrix
+INTERFACE dm_get
+  MODULE PROCEDURE dm_get_
+  MODULE PROCEDURE dm_get_exc_
+END INTERFACE dm_get
+
+!>  \brief Interface to setter for individual entries in matrix
+INTERFACE dm_set
+  MODULE PROCEDURE dm_set_
+  MODULE PROCEDURE dm_set_exc_
+END INTERFACE dm_set
+
+!>  \brief Interface for addition of two matrixT
+INTERFACE dm_add
+  MODULE PROCEDURE dm_add_
+  MODULE PROCEDURE dm_add_exc_
+END INTERFACE dm_add
+
+!>  \brief Operator overload for addition
+INTERFACE OPERATOR (+)
+  MODULE PROCEDURE dm_add_
+END INTERFACE
+
+!>  \brief Interface for scalar multiplication
+INTERFACE dm_scalMul
+  MODULE PROCEDURE dm_scal_mul_mat_scal_
+END INTERFACE dm_scalMul
+
+!>  \brief Interface for matrix-vector multiplication
+INTERFACE dm_vecMul
+  MODULE PROCEDURE dm_vec_mul_
+  MODULE PROCEDURE dm_vec_mul_exc_
+END INTERFACE dm_vecMul
+
+!>  \brief Interface for matrix-matrix multiplication
+INTERFACE dm_matMul
+  MODULE PROCEDURE dm_mat_mul_
+  MODULE PROCEDURE dm_mat_mul_exc_
+END INTERFACE dm_matMul
+
+!>  \brief Operator overload for multiplication
+!!  (includes scalar, matrix-vector, and matrix-matrix multiplication)
+INTERFACE OPERATOR (*)
+  MODULE PROCEDURE dm_scal_mul_mat_scal_
+  MODULE PROCEDURE dm_scal_mul_scal_mat_
+  MODULE PROCEDURE dm_vec_mul_
+  MODULE PROCEDURE dm_mat_mul_
+END INTERFACE
+
+!>  \brief Interface for matrix transpose
+INTERFACE dm_transpose
+  MODULE PROCEDURE dm_transpose_
+END INTERFACE dm_transpose
+
+
+
+CONTAINS
+
+
+
+! ************************************************************************
+! ACCESS PROGRAMS
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for matrixT (non-exception checking)
+!!
+!!  \param self Reference to the dense matrix to be initialized
+!!  \param m    Number of rows in the matrix
+!!  \param n    Number of columns in the matrix
+!!
+!!  This routine initializes the matrixT object referenced by self.
+!!  The data structures contained in self are allocated and initial values
+!!  are set to zero.
+! ------------------------------------------------------------------------
+SUBROUTINE dm_init_ (self, m,n)
+  TYPE(matrixT), INTENT(INOUT) :: self
+  INTEGER, INTENT(IN) :: m,n
+  INTEGER :: i,j    !> loop variables
+
+  !> only reallocate if new dimensions do not match existing dimensions
+  IF (dm_numRows(self).NE.m .OR. dm_numCols(self).NE.n) THEN
+
+    !> reset object if it was previously initialized
+    CALL dm_clean(self)
+
+    !> allocate new data structure
+    ALLOCATE(self%dat(m,n))
+
+  END IF
+
+  !> ensure data is initialized to zero
+  DO j = 1,n
+    DO i = 1,m
+      self%dat(i,j) = 0.d0
+    END DO
+  END DO
+
+END SUBROUTINE dm_init_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for matrixT (exception checking)
+!!
+!!  \param self Reference to the dense matrix to be initialized
+!!  \param m    Number of rows in the matrix
+!!  \param n    Number of columns in the matrix
+!!  \param exc  Error code
+!!
+!!  This routine initializes the matrixT object referenced by self.
+!!  The data structures contained in self are allocated and initial values
+!!  are set to zero. If the specified dimensions are invalid, a SZE
+!!  exception is returned. If allocation of data structures fails, an
+!!  ALLOC exception is returned.
+! ------------------------------------------------------------------------
+SUBROUTINE dm_init_exc_ (self, m,n, exc)
+  TYPE(matrixT), INTENT(INOUT) :: self
+  INTEGER, INTENT(IN) :: m,n
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: e      !> allocation info code
+  INTEGER :: i,j    !> loop variables
+
+  !> if dimensions are invalid, raise SZE exception
+  IF (m.LE.0 .OR. n.LE.0) THEN
+    exc=SZE
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> only reallocate if new dimensions do not match existing dimensions
+  IF (dm_numRows(self).NE.m .OR. dm_numCols(self).NE.n) THEN
+
+    !> reset object if it was previously initialized
+    CALL dm_clean(self)
+
+    !> allocate new data structure for matrix storage
+    ALLOCATE(self%dat(m,n), STAT=e)
+
+    !> if error code is returned, raise ALLOC exception
+    IF (e.NE.0) THEN
+      exc=ALLOC
+      CALL log_printLogMsg(exc,sdr)
+      RETURN
+    ELSE
+      exc=OK
+    END IF
+
+  END IF
+
+  !> ensure data is initialized to zero
+  DO j = 1,n
+    DO i = 1,m
+      self%dat(i,j) = 0.d0
+    END DO
+  END DO
+
+END SUBROUTINE dm_init_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Destructor for matrixT
+!!
+!!  \param self Reference to the dense matrix to be destroyed
+!!
+!!  This routine deallocates existing data structures.
+! ------------------------------------------------------------------------
+SUBROUTINE dm_clean_ (self)
+  TYPE(matrixT), INTENT(INOUT) :: self
+
+  IF (ALLOCATED(self%dat)) DEALLOCATE(self%dat)
+
+END SUBROUTINE dm_clean_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for number of rows
+!!
+!!  \param  self  Reference to the dense matrix object
+!!  \return m     Number of rows in the matrix
+!!
+!!  This routine determines the number of rows allocated to the matrix
+!!  object. If the matrix is not initialized it returns 0.
+! ------------------------------------------------------------------------
+FUNCTION dm_num_rows_ (self) RESULT(m)
+  TYPE(matrixT), INTENT(IN) :: self
+  INTEGER :: m
+
+  !> if data is initialized, return number of rows
+  IF (ALLOCATED(self%dat)) THEN
+    m = SIZE(self%dat,1)
+  ELSE
+    m = 0   !> if not initialized, there are no rows
+  END IF
+
+END FUNCTION dm_num_rows_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for number of columns
+!!
+!!  \param  self  Reference to the dense matrix object
+!!  \return n     Number of columns in the matrix
+!!
+!!  This routine determines the number of columns allocated to the matrix
+!!  object. If the matrix is not initialized it returns 0.
+! ------------------------------------------------------------------------
+FUNCTION dm_num_cols_ (self) RESULT(n)
+  TYPE(matrixT), INTENT(IN) :: self
+  INTEGER :: n
+
+  !> if data is initialized, return number of columns
+  IF (ALLOCATED(self%dat)) THEN
+    n = SIZE(self%dat,2)
+  ELSE
+    n = 0   !> if not initialized, there are no columns
+  END IF
+
+END FUNCTION dm_num_cols_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for matrix entries (non-exception checking)
+!!
+!!  \param  self  Reference to the dense matrix object
+!!  \param  i     Row index
+!!  \param  j     Column index
+!!  \return v     Value at location (i,j) of the matrix
+!!
+!!  This routine determines the value at a particular location in the
+!!  matrix.
+! ------------------------------------------------------------------------
+FUNCTION dm_get_ (self, i,j) RESULT(v)
+  TYPE(matrixT), INTENT(IN) :: self
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: v
+
+  v = self%dat(i,j)
+
+END FUNCTION dm_get_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for matrix entries (exception checking)
+!!
+!!  \param  self  Reference to the dense matrix object
+!!  \param  i     Row index
+!!  \param  j     Column index
+!!  \param  exc   Error code
+!!  \return v     Value at location (i,j) of the matrix
+!!
+!!  This routine determines the value at a particular location in the
+!!  matrix. If the location is not inside the matrix, it returns a POSIT
+!!  exception.
+! ------------------------------------------------------------------------
+FUNCTION dm_get_exc_ (self, i,j, exc) RESULT(v)
+  TYPE(matrixT), INTENT(IN) :: self
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: v
+
+  !> make sure desired indices are inside the matrix
+  IF (i.GT.dm_numRows(self) .OR. i.LE.0 &
+      .OR. j.GT.dm_numCols(self) .OR. j.LE.0) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    v = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception getter
+  v = dm_get(self, i,j)
+
+END FUNCTION dm_get_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for matrix entries (non-exception checking)
+!!
+!!  \param self Reference to the dense matrix object
+!!  \param i    Row index
+!!  \param j    Column index
+!!  \param v    Value to be stored at location (i,j) of the matrix
+!!
+!!  This routine sets the value at a particular location in the
+!!  matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE dm_set_ (self, i,j,v)
+  TYPE(matrixT), INTENT(INOUT) :: self
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: v
+
+  self%dat(i,j) = v
+
+END SUBROUTINE dm_set_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for matrix entries (exception checking)
+!!
+!!  \param self Reference to the dense matrix object
+!!  \param i    Row index
+!!  \param j    Column index
+!!  \param v    Value to be stored at location (i,j) of the matrix
+!!  \param exc  Error code
+!!
+!!  This routine sets the value at a particular location in the
+!!  matrix. If the location is not inside the matrix, it returns a POSIT
+!!  exception.
+! ------------------------------------------------------------------------
+SUBROUTINE dm_set_exc_ (self, i,j,v, exc)
+  TYPE(matrixT), INTENT(INOUT) :: self
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: v
+  INTEGER, INTENT(OUT) :: exc
+
+  !> make sure desired indices are inside the matrix
+  IF (i.GT.dm_numRows(self) .OR. i.LE.0 &
+      .OR. j.GT.dm_numCols(self) .OR. j.LE.0) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception setter
+  CALL dm_set(self, i,j,v)
+
+END SUBROUTINE dm_set_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Add two dense matrix objects (non-exception checking)
+!!
+!!  \param  self  Reference to the first (left-hand) dense matrix object
+!!  \param  other Reference to the second (right-hand) dense matrix object
+!!  \return new   Reference to the resulting banded dense object
+!!
+!!  This routine adds two dense matrix objects.
+! ------------------------------------------------------------------------
+FUNCTION dm_add_ (self,other) RESULT(new)
+  TYPE(matrixT), INTENT(IN) :: self,other
+  TYPE(matrixT) :: new
+
+  !> initialize solution matrix
+  CALL dm_init(new, dm_numRows(self),dm_numCols(self))
+
+  !> Add the matrices (using array ops for efficiency)
+  new%dat = self%dat + other%dat
+
+END FUNCTION dm_add_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Add two dense matrix objects (exception checking)
+!!
+!!  \param  self  Reference to the first (left-hand) dense matrix object
+!!  \param  other Reference to the second (right-hand) dense matrix object
+!!  \param  exc   Error code
+!!  \return new   Reference to the resulting dense matrix object
+!!
+!!  This routine adds two dense matrix objects. If the dimensions of the
+!!  two input matrices do not match, it returns a DIMEN exception.
+! ------------------------------------------------------------------------
+FUNCTION dm_add_exc_ (self,other, exc) RESULT(new)
+  TYPE(matrixT), INTENT(IN) :: self,other
+  INTEGER, INTENT(OUT) :: exc
+  TYPE(matrixT) :: new
+
+  !> make sure that the two matrices have the same number of rows
+  IF(dm_numRows(self).NE.dm_numRows(other) &
+          .OR. dm_numCols(self).NE.dm_numCols(other)) THEN
+    exc=DIMEN
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  new = dm_add(self,other)
+
+END FUNCTION dm_add_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Scalar multiplication (self*k version)
+!!
+!!  \param  self  Reference to the dense matrix object
+!!  \param  k     Scalar multiplication factor
+!!  \return new   Reference to the resulting dense matrix object
+!!
+!!  This routine multiplies a dense matrix by a scalar factor.
+! ------------------------------------------------------------------------
+FUNCTION dm_scal_mul_mat_scal_ (self, k) RESULT(new)
+  TYPE(matrixT), INTENT(IN) :: self
+  DOUBLE PRECISION, INTENT(IN) :: k
+  TYPE(matrixT) :: new
+
+  !> initialize solution matrix
+  CALL dm_init(new, dm_numRows(self),dm_numCols(self))
+
+  !> perform multiplication
+  new%dat = k * self%dat
+
+END FUNCTION dm_scal_mul_mat_scal_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Scalar multiplication (k*self version)
+!!
+!!  \param  self  Reference to the dense matrix object
+!!  \param  k     Scalar multiplication factor
+!!  \return new   Reference to the resulting dense matrix object
+!!
+!!  This routine multiplies a dense matrix by a scalar factor. The
+!!  overload is necessary for the OPERATOR (*) overload. This version
+!!  simply calls the other version for better maintainability.
+! ------------------------------------------------------------------------
+FUNCTION dm_scal_mul_scal_mat_ (k, self) RESULT(new)
+  DOUBLE PRECISION, INTENT(IN) :: k
+  TYPE(matrixT), INTENT(IN) :: self
+  TYPE(matrixT) :: new
+
+  new = dm_scalMul(self,k)
+
+END FUNCTION dm_scal_mul_scal_mat_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Post-multiplication of a dense matrix by a vector (non-exception checking)
+!!
+!!  \param  self  Reference to the first (left-hand) dense matrix object
+!!  \param  other Reference to the vector (right-hand) object
+!!  \return new   Reference to the resulting vector object
+!!
+!!  This routine post-multiplies a dense matrix by a vector. That is, it
+!!  performs self*other, not other*self.
+! ------------------------------------------------------------------------
+FUNCTION dm_vec_mul_ (self,other) RESULT(new)
+  TYPE(matrixT), INTENT(IN) :: self
+  TYPE(vectorT), INTENT(IN) :: other
+  TYPE(vectorT) :: new
+
+  !> initialize the solution vector
+  CALL vec_init(new, dm_numRows(self))
+
+  !> perform multiplication (using Fortran built-in for efficiency)
+  new%dat = MATMUL(self%dat,other%dat)
+
+END FUNCTION dm_vec_mul_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Post-multiplication of a dense matrix by a vector (exception checking)
+!!
+!!  \param  self  Reference to the first (left-hand) dense matrix object
+!!  \param  other Reference to the vector (right-hand) object
+!!  \param  exc   Error code
+!!  \return new   Reference to the resulting vector object
+!!
+!!  This routine post-multiplies a dense matrix by a vector. That is, it
+!!  performs self*other, not other*self. If the dimensions of the two
+!!  objects are not compatible (number of columns in self does not equal
+!!  number of rows in other), it returns a DIMEN exception.
+! ------------------------------------------------------------------------
+FUNCTION dm_vec_mul_exc_ (self,other, exc) RESULT(new)
+  TYPE(matrixT), INTENT(IN) :: self
+  TYPE(vectorT), INTENT(IN) :: other
+  INTEGER, INTENT(OUT) :: exc
+  TYPE(vectorT) :: new
+
+  !> make sure dimensions are compatible
+  IF (dm_numCols(self).NE.vec_length(other)) THEN
+    exc=DIMEN
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  new = dm_vecMul(self,other)
+
+END FUNCTION dm_vec_mul_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Multiplication of two dense matrices (non-exception checking)
+!!
+!!  \param  self  Reference to the first (left-hand) dense matrix object
+!!  \param  other Reference to the second (right-hand) dense matrix object
+!!  \return new   Reference to the resulting matrix object
+!!
+!!  This routine multiplies two dense matrices.
+! ------------------------------------------------------------------------
+FUNCTION dm_mat_mul_ (self,other) RESULT(new)
+  TYPE(matrixT), INTENT(IN) :: self, other
+  TYPE(matrixT) :: new
+  INTEGER :: m,n
+
+  !> initialize solution matrix
+  CALL dm_init(new, dm_numRows(self),dm_numCols(other))
+
+  !> perform multiplication (using Fortran built-in for efficiency)
+  new%dat = MATMUL(self%dat,other%dat)
+
+END FUNCTION dm_mat_mul_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Multiplication of two dense matrices (non-exception checking)
+!!
+!!  \param  self  Reference to the first (left-hand) dense matrix object
+!!  \param  other Reference to the second (right-hand) dense matrix object
+!!  \param  exc   Error code
+!!  \return new   Reference to the resulting matrix object
+!!
+!!  This routine multiplies two dense matrices. If the dimensions of the
+!!  two objects are not compatible (number of columns in self does not
+!!  equal number of rows in other), it returns a DIMEN exception.
+! ------------------------------------------------------------------------
+FUNCTION dm_mat_mul_exc_ (self,other, exc) RESULT(new)
+  TYPE(matrixT), INTENT(IN) :: self, other
+  INTEGER, INTENT(OUT) :: exc
+  TYPE(matrixT) :: new
+
+  !> make sure dimensions are compatible
+  IF (dm_numCols(self).NE.dm_numRows(other)) THEN
+    exc=DIMEN
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  new = dm_matMul(self,other)
+
+END FUNCTION dm_mat_mul_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Transpose of a matrix
+!!
+!!  \param  self  Reference to the input dense matrix object
+!!  \return new   Reference to the transposed matrix object
+! ------------------------------------------------------------------------
+FUNCTION dm_transpose_ (self) RESULT (new)
+  TYPE(matrixT), INTENT(IN) :: self
+  TYPE(matrixT) :: new
+
+  !> initialize result matrix
+  CALL dm_init(new, dm_numCols(self),dm_numRows(self))
+
+  !> take the transpose (using Fortran built-in for efficiency)
+  new%dat = TRANSPOSE(self%dat)
+
+END FUNCTION dm_transpose_
+
+END MODULE dense_matrix_def
+
+
+
+! ************************************************************************
+! LOCAL FUNCTIONS
+! ************************************************************************
+
+! none

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/dense_matrix_test.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module for testing Dense Matrix data type
+! ------------------------------------------------------------------------
+MODULE dense_matrix_test
+USE fruit                   !> Unit testing framework
+USE log_message_control     !> Printing log/error messages
+USE log_messages            !> Log/error codes
+USE dense_matrix_def        !> Dense Matrix data type
+USE vector_def              !> Vector data type
+
+IMPLICIT NONE
+
+
+CONTAINS
+
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for OK exception message on allocation
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test dense matrix
+!!  \param testName Filename for log file (required for exceptions)
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param expMsg   Expected log message
+!!  \param actMsg   Actual log message
+!!
+!!  This test initializes a matrixT and makes sure that the exception
+!!  message is OK (i.e. allocation did not fail).
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_allocation_MSG
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_allocation_MSG'
+  TYPE(matrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expMsg=OK
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log message file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrix and check the exception
+  CALL dm_init(test, m,n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrix
+  CALL log_closeLogFile()
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_allocation_MSG
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for SZE exception message on allocation
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test dense matrix
+!!  \param testName Filename for log file (required for exceptions)
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param expMsg   Expected log message
+!!  \param actMsg   Actual log message
+!!
+!!  This test attempts to initialize a matrixT with invalid size
+!!  parameters and verifies that the correct exception is returned.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_allocation_SZE
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_allocation_SZE'
+  TYPE(matrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expMsg=SZE
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> try to initialize with m=-1
+  CALL dm_init(test, -1,n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to initialize with n=-1
+  CALL dm_init(test, m,-1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrix
+  CALL log_closeLogFile()
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_allocation_SZE
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for initialization of matrix data to zeros.
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test dense matrix
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param expDat   Expected initial contents of matrix data
+!!
+!!  This test initializes a matrixT and ensures that the data is
+!!  initialized to zeros.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_allocation_DAT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_allocation_DAT'
+  TYPE(matrixT) :: test
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up the expected data
+  expDat = RESHAPE(  (/ 0.d0,0.d0,0.d0,0.d0,0.d0,0.d0 /), SHAPE(expDat) )
+
+  !> initialize matrix and test actual data
+  CALL dm_init(test, m,n)
+  CALL assertEquals(expDat,test%dat, m,n)
+
+  !> deallocate matrix
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_allocation_DAT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for deallocation
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test       Test dense matrix
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of rows/columns in the matrix
+!!  \param expBefore  Expected allocation status before deallocation
+!!  \param expAfter   Expected allocation status after deallocation
+!!  \param actBefore  Actual allocation status before deallocation
+!!  \param actAfter   Actual allocation status after deallocation
+!!
+!!  This test initializes a matrixT and ensures that it is
+!!  allocated. It then deallocates the object and ensures that it has
+!!  been deallocated.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_deallocation
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_deallocation'
+  TYPE(matrixT) :: test
+  INTEGER, PARAMETER :: m=3,n=2
+  LOGICAL, PARAMETER :: expBefore = .TRUE.
+  LOGICAL, PARAMETER :: expAfter = .FALSE.
+  LOGICAL :: actBefore, actAfter
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL dm_init(test, m,n)
+
+  !> make sure dat is allocated
+  actBefore = ALLOCATED(test%dat)
+  CALL assertEquals(expBefore,actBefore)
+
+  !> deallocate the matrix
+  CALL dm_clean(test)
+
+  !> make sure dat is deallocated
+  actAfter = ALLOCATED(test%dat)
+  CALL assertEquals(expAfter,actAfter)
+
+END SUBROUTINE test_dm_deallocation
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for number of rows when matrix is not allocated
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test       Test dense matrix
+!!  \param expected   Expected number of rows
+!!  \param actual     Actual number of rows
+!!
+!!  This test makes sure that the number of rows is returned as 0 when
+!!  the matrix is not allocated.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_num_rows_not_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_num_rows_not_allocated'
+  TYPE(matrixT) :: test
+  INTEGER, PARAMETER :: expected = 0
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> check number of rows
+  actual = dm_numRows(test)
+  CALL assertEquals(expected, actual)
+
+END SUBROUTINE test_dm_num_rows_not_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for number of rows when matrix is allocated
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test       Test dense matrix
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expected   Expected number of rows
+!!  \param actual     Actual number of rows
+!!
+!!  This test checks that the number of rows returned is correct when the
+!!  matrix is allocated.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_num_rows_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_num_rows_allocated'
+  TYPE(matrixT) :: test
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expected = m
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL dm_init(test, m,n)
+
+  !> check number of rows
+  actual = dm_numRows(test)
+  CALL assertEquals(expected, actual)
+
+  !> deallocate the matrix
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_num_rows_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for number of columns when matrix is not allocated
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test       Test dense matrix
+!!  \param expected   Expected number of columns
+!!  \param actual     Actual number of columns
+!!
+!!  This test makes sure that the number of columns is returned as 0 when
+!!  the matrix is not allocated
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_num_cols_not_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_num_cols_not_allocated'
+  TYPE(matrixT) :: test
+  INTEGER, PARAMETER :: expected = 0
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> check number of rows
+  actual = dm_numCols(test)
+  CALL assertEquals(expected, actual)
+
+END SUBROUTINE test_dm_num_cols_not_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for number of columns when matrix is allocated
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test       Test dense matrix
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expected   Expected number of columns
+!!  \param actual     Actual number of columns
+!!
+!!  This test checks that the number of columns returned is correct when
+!!  the matrix is allocated.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_num_cols_allocated
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_num_cols_allocated'
+  TYPE(matrixT) :: test
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expected = n
+  INTEGER :: actual
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL dm_init(test, m,n)
+
+  !> check number of columns
+  actual = dm_numCols(test)
+  CALL assertEquals(expected, actual)
+
+  !> deallocate the matrix
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_num_cols_allocated
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception from dm_get
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test dense matrix
+!!  \param testName Filename for log file (required for exceptions)
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param expMsg   Expected log message
+!!  \param actMsg   Actual log message
+!!  \param v        Dummy variable for get function return
+!!
+!!  This test checks that a POSIT exception is returned when the requested
+!!  location is not inside the matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_get_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_get_POSIT'
+  TYPE(matrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expMsg = POSIT
+  INTEGER :: actMsg
+  DOUBLE PRECISION :: v
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrix
+  CALL dm_init(test, m,n)
+
+  !> try to get beyond last row
+  v = dm_get(test, m+1,n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first row
+  v = dm_get(test, 0,n, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get after last column
+  v = dm_get(test, m,n+1, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to get before first column
+  v = dm_get(test, m,0, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize the log file and deallocate the matrix
+  CALL log_closeLogFile()
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_get_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct value return from bsm_get
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test dense matrix
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of rows/columns in the matrix
+!!  \param i        Row index for test location
+!!  \param j        Column index for test location
+!!  \param expVal   Expected data value
+!!  \param actVal   Actual data value
+!!
+!!  This test checks that the correct value is returned from the get
+!!  access program.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_get_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_get_VAL'
+  TYPE(matrixT) :: test
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: i=1,j=2
+  DOUBLE PRECISION, PARAMETER :: expVal = 3.d0
+  DOUBLE PRECISION :: actVal
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL dm_init(test, m,n)
+
+  !> set the value manually in the internal data structure
+  test%dat(i,j) = expVal
+
+  !> get the value using the access program
+  actVal = dm_get(test, i,j)
+  CALL assertEquals(expVal,actVal)
+
+  !> deallocate the matrix
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_get_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for POSIT exception from dm_set
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test dense matrix
+!!  \param testName Filename for log file (required for exceptions)
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param expMsg   Expected log message
+!!  \param actMsg   Actual log message
+!!  \param v        Dummy variable for set function input
+!!
+!!  This test checks that a POSIT exception is returned when the requested
+!!  location is not inside the matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_set_POSIT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_set_POSIT'
+  TYPE(matrixT) :: test
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expMsg = POSIT
+  DOUBLE PRECISION, PARAMETER :: v=0.d0
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize the matrix
+  CALL dm_init(test, m,n)
+
+  !> try to set after last row
+  CALL dm_set(test, m+1,n,v, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set before first row
+  CALL dm_set(test, 0,n,v, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set after last column
+  CALL dm_set(test, m,n+1,v, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> try to set before first column
+  CALL dm_set(test, m,0,v, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrix
+  CALL log_closeLogFile()
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_set_POSIT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct value return after dm_set
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test     Test dense matrix
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param i        Row index for test location
+!!  \param j        Column index for test location
+!!  \param expVal   Expected data value
+!!  \param actVal   Actual data value
+!!
+!!  This test checks that the correct value is entered by the set
+!!  access program.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_set_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_set_VAL'
+  TYPE(matrixT) :: test
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: i=1,j=2
+  DOUBLE PRECISION, PARAMETER :: expVal = 3.d0
+  DOUBLE PRECISION :: actVal
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize the matrix
+  CALL dm_init(test, m,n)
+
+  !> set the value
+  CALL dm_set(test, i,j,expVal)
+  actVal = dm_get(test, i,j)
+  CALL assertEquals(expVal,actVal)
+
+  !> deallocate matrix
+  CALL dm_clean(test)
+
+END SUBROUTINE test_dm_set_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception when adding matrices
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      First input dense matrix
+!!  \param test2      Second input dense matrix
+!!  \param test3      Output dense matrix
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!
+!!  This test checks that a DIMEN exception is raised when matrices with
+!!  incompatible dimensions are added.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_add_DIMEN
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_add_DIMEN'
+  TYPE(matrixT) :: test1, test2, test3
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expMsg=DIMEN
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize input matrices (data contents not important)
+  CALL dm_init(test1, m,n)
+  CALL dm_init(test2, m+1,n)  !> note different number of rows
+
+  !> attempt to add the matrices
+  test3 = dm_add(test1,test2, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> re-initialize input matrices (data contents not important)
+  CALL dm_init(test1, m,n)
+  CALL dm_init(test2, m,n+1)  !> note different number of columns
+
+  !> attempt to add the matrices
+  test3 = dm_add(test1,test2, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrices
+  CALL log_closeLogFile()
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_dm_add_DIMEN
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct addition of matrices
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      First input dense matrix
+!!  \param test2      Second input dense matrix
+!!  \param test3      Output dense matrix
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expDat     Expected result of addition
+!!
+!!  This test checks that the correct result is obtained when adding two
+!!  dense matrices.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_add_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_add_VAL'
+  TYPE(matrixT) :: test1, test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize expected result
+  expDat = RESHAPE(  (/ 3.d0,3.d0,3.d0,3.d0,3.d0,3.d0 /), SHAPE(expDat) )
+
+  !> initialize first input matrix
+  !! (loop sets matrix to all ones)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> initialize second input matrix
+  !! (loop sets matrix to all twos)
+  CALL dm_init(test2, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test2, i,j, 2.d0)
+    END DO
+  END DO
+
+  !> add the matrices
+  test3 = dm_add(test1,test2)
+  CALL assertEquals(expDat,test3%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_dm_add_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct addition of matrices ( with OPERATOR (+) )
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      First input dense matrix
+!!  \param test2      Second input dense matrix
+!!  \param test3      Output dense matrix
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expDat     Expected result of addition
+!!
+!!  This test checks that the correct result is obtained when adding two
+!!  dense matrices using the (+) operator.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_add_OP
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_add_OP'
+  TYPE(matrixT) :: test1, test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize expected result
+  expDat = RESHAPE(  (/ 3.d0,3.d0,3.d0,3.d0,3.d0,3.d0 /), SHAPE(expDat) )
+
+  !> initialize first input matrix
+  !! (loop sets matrix to all ones)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> initialize second input matrix
+  !! (loop sets matrix to all twos)
+  CALL dm_init(test2, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test2, i,j, 2.d0)
+    END DO
+  END DO
+
+  !> add the matrices
+  test3 = test1 + test2
+  CALL assertEquals(expDat,test3%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_dm_add_OP
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for scalar multiplication
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1    Input dense matrix
+!!  \param test2    Output dense matrix
+!!  \param k        Scalar coefficient
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param expDat   Expected data contents
+!!
+!!  This test checks that scalar multiplication is performed correctly.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_scal_mul_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_scal_mul_VAL'
+  TYPE(matrixT) :: test1, test2
+  DOUBLE PRECISION, PARAMETER :: k=3.d0
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize expected result
+  expDat = RESHAPE(  (/ 3.d0,3.d0,3.d0,3.d0,3.d0,3.d0 /), SHAPE(expDat) )
+
+  !> initialize matrix
+  !! (loop sets matrix to all ones)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> multiply by scalar
+  test2 = dm_scalMul(test1,k)
+  CALL assertEquals(expDat,test2%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_dm_scal_mul_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for scalar multiplication (by zero)
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1    Input dense matrix
+!!  \param test2    Output dense matrix
+!!  \param k        Scalar coefficient (zero)
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param expDat   Expected data contents
+!!
+!!  This test checks that scalar multiplication is performed correctly.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_scal_mul_ZERO
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_scal_mul_ZERO'
+  TYPE(matrixT) :: test1, test2
+  DOUBLE PRECISION, PARAMETER :: k=0.d0
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize expected result
+  expDat = RESHAPE(  (/ 0.d0,0.d0,0.d0,0.d0,0.d0,0.d0 /), SHAPE(expDat) )
+
+  !> initialize matrix
+  !! (loop sets matrix to all ones)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> multiply by zero
+  test2 = dm_scalMul(test1,k)
+  CALL assertEquals(expDat,test2%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_dm_scal_mul_ZERO
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for scalar multiplication ( using OPERATOR (*) )
+!!
+!!  \param unit_name  Name of unit test (for FRUIT)
+!!  \param test1    Input dense matrix
+!!  \param test2    Output dense matrix
+!!  \param k        Scalar coefficient (zero)
+!!  \param m        Number of rows in the matrix
+!!  \param n        Number of columns in the matrix
+!!  \param expDat   Expected data contents
+!!
+!!  This test checks that scalar multiplication is performed correctly
+!!  when using the overloaded (*) operator.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_scal_mul_OP
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_scal_mul_OP'
+  TYPE(matrixT) :: test1, test2
+  DOUBLE PRECISION, PARAMETER :: k=3.d0
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize expected result
+  expDat = RESHAPE(  (/ 3.d0,3.d0,3.d0,3.d0,3.d0,3.d0 /), SHAPE(expDat) )
+
+  !> initialize matrix
+  !! (loop sets matrix to all ones)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> multiply by scalar
+  test2 = k*test1
+  CALL assertEquals(expDat,test2%dat, m,n)
+
+  !> clear output matrix
+  CALL dm_clean(test2)
+
+  !> multiply by scalar (switch order of inputs)
+  test2 = test1*k
+  CALL assertEquals(expDat,test2%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_dm_scal_mul_OP
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception when performing matrix-vector multiplication
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      Input dense matrix
+!!  \param test2      Input vector
+!!  \param test3      Dummy output vector
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!
+!!  This test checks that a DIMEN exception is raised when matrix-vector
+!!  multiplication is attempted with a vector whose length does not equal
+!!  the number of rows in the matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_vec_mul_DIMEN
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_vec_mul_DIMEN'
+  TYPE(matrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expMsg=DIMEN
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> set up matrix and vector (data contents not important)
+  CALL dm_init(test1, m,n)
+  CALL vec_init(test2, m)
+
+  !> attempt matrix-vector multiplication
+  test3 = dm_vecMul(test1,test2, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate objects
+  CALL log_closeLogFile()
+  CALL dm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_dm_vec_mul_DIMEN
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct matrix-vector multiplication
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      Input dense matrix
+!!  \param test2      Input vector
+!!  \param test3      Output vector
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-vector multiplication is performed
+!!  correctly in the general case (input matrix and vector contain data,
+!!  but it is not of a special form).
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_vec_mul_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_vec_mul_VAL'
+  TYPE(matrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set expected result
+  expDat = RESHAPE(  (/ 9.d0,12.d0,15.d0 /), SHAPE(expDat) )
+
+  !> initialize input matrix
+  !! (loop sets up data)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize input vector
+  !! (loop sets up data)
+  CALL vec_init(test2, n)
+  DO i = 1,n
+    CALL vec_set(test2, i, DBLE(i))
+  END DO
+
+  !> perform multiplication
+  test3 = dm_vecMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, m)
+
+  !> deallocate objects
+  CALL dm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_dm_vec_mul_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for matrix-vector multiplication (by the zero vector)
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      Input dense matrix
+!!  \param test2      Input vector (zeros)
+!!  \param test3      Output vector
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-vector multiplication is performed
+!!  correctly when the input vector is all zeros.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_vec_mul_ZERO
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_vec_mul_ZERO'
+  TYPE(matrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set expected result
+  expDat = RESHAPE(  (/ 0.d0,0.d0,0.d0 /), SHAPE(expDat) )
+
+  !> initialize input matrix
+  !! (loop sets up data)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize input vector (all zeros)
+  CALL vec_init(test2, n)
+
+  !> perform multiplication
+  test3 = dm_vecMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, m)
+
+  !> deallocate objects
+  CALL dm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_dm_vec_mul_ZERO
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for matrix-vector multiplication (by the identity matrix)
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      Input dense matrix (identity)
+!!  \param test2      Input vector
+!!  \param test3      Output vector
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-vector multiplication is performed
+!!  correctly when the input matrix is the identity for multiplication.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_vec_mul_IDENT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_vec_mul_IDENT'
+  TYPE(matrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  INTEGER, PARAMETER :: m=3
+  DOUBLE PRECISION, DIMENSION(m) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize input matrix
+  !! (loop sets up identity matrix)
+  CALL dm_init(test1, m,m)
+  DO j = 1,m
+    DO i = 1,m
+      IF (i.EQ.j) CALL dm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> initialize input vector
+  !! (loop sets data)
+  CALL vec_init(test2, m)
+  DO i = 1,m
+    CALL vec_set(test2, i, DBLE(i))
+  END DO
+
+  !> expected result is the same as the initial vector
+  expDat = test2%dat
+
+  !> perform multiplication
+  test3 = dm_vecMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, m)
+
+  !> deallocate objects
+  CALL dm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_dm_vec_mul_IDENT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct matrix-vector multiplication ( using OPERATOR (*) )
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      Input dense matrix
+!!  \param test2      Input vector
+!!  \param test3      Output vector
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-vector multiplication is performed
+!!  correctly in the general case (input matrix and vector contain data,
+!!  but it is not of a special form). The overloaded operator (*) is used.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_vec_mul_OP
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_vec_mul_OP'
+  TYPE(matrixT) :: test1
+  TYPE(vectorT) :: test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result
+  expDat = RESHAPE(  (/ 9.d0,12.d0,15.d0 /), SHAPE(expDat) )
+
+  !> initialize input matrix
+  !! (loop sets data)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize input vector
+  !! (loop sets data)
+  CALL vec_init(test2, n)
+  DO i = 1,n
+    CALL vec_set(test2, i, DBLE(i))
+  END DO
+
+  !> perform multiplication
+  test3 = test1*test2
+  CALL assertEquals(expDat,test3%dat, m)
+
+  !> deallocate objects
+  CALL dm_clean(test1)
+  CALL vec_clean(test2)
+  CALL vec_clean(test3)
+
+END SUBROUTINE test_dm_vec_mul_OP
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for DIMEN exception when performing matrix-matrix multiplication
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      First (left-hand) input dense matrix
+!!  \param test2      Second (right-hand) input dense matrix
+!!  \param test3      Dummy output matric
+!!  \param testName   Filename for log file (required for exceptions)
+!!  \param m          Number of rows in the matrix
+!!  \param n          Number of columns in the matrix
+!!  \param expMsg     Expected exception message
+!!  \param actMsg     Actual exception message
+!!
+!!  This test checks that a DIMEN exception is raised when matrix-matrix
+!!  multiplication is attempted between matrices whose dimensions are not
+!!  compatible (i.e. number of columns in test1 does not equal number of
+!!  rows in test2).
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_mat_mul_DIMEN
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_mat_mul_DIMEN'
+  TYPE(matrixT) :: test1, test2, test3
+  CHARACTER (LEN=*), PARAMETER :: testName = 'testName'
+  INTEGER, PARAMETER :: m=3,n=2
+  INTEGER, PARAMETER :: expMsg=DIMEN
+  INTEGER :: actMsg
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize log file
+  CALL log_setFileName(testName)
+  CALL log_initLogFile()
+
+  !> initialize matrices (data content not important)
+  CALL dm_init(test1, m,n)
+  CALL dm_init(test2, m,n)
+
+  !> attempt matrix-matrix multiplication
+  test3 = dm_matMul(test1,test2, actMsg)
+  CALL assertEquals(expMsg,actMsg)
+
+  !> finalize log file and deallocate matrices
+  CALL log_closeLogFile()
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_dm_mat_mul_DIMEN
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct matrix-matrix multiplication
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      First (left-hand) input dense matrix
+!!  \param test2      Second (right-hand) input dense matrix
+!!  \param test3      Output matrix
+!!  \param m          Number of rows in matrices
+!!  \param n          Number of columns in matrices
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-matrix multiplication is performed
+!!  correctly in the general case (input matrices contain data,
+!!  but it is not of a special form).
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_mat_mul_VAL
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_mat_mul_VAL'
+  TYPE(matrixT) :: test1, test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result
+  expDat = RESHAPE( (/ &
+                    30.d0,36.d0,42.d0,66.d0,81.d0,96.d0 &
+                    /), SHAPE(expDat) )
+
+  !> initialize first matrix (dimensions of m x m)
+  !! (loops sets up data)
+  CALL dm_init(test1, m,m)
+  DO j = 1,m
+    DO i = 1,m
+      CALL dm_set(test1, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize second matrix (dimensions of m x n)
+  !! (loops sets up data)
+  CALL dm_init(test2, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test2, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> perform matrix-matrix multiplication
+  test3 = dm_matMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_dm_mat_mul_VAL
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct matrix-matrix multiplication (by zero matrix)
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      First (left-hand) input dense matrix (zeros)
+!!  \param test2      Second (right-hand) input dense matrix
+!!  \param test3      Output matrix
+!!  \param m          Number of rows in matrices
+!!  \param n          Number of columns in matrices
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-matrix multiplication is performed
+!!  correctly for multiplication by a zero matrix.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_mat_mul_ZERO
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_mat_mul_ZERO'
+  TYPE(matrixT) :: test1, test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result
+  expDat = RESHAPE(  (/ 0.d0,0.d0,0.d0,0.d0,0.d0,0.d0 /), SHAPE(expDat) )
+
+  !> initialize first matrix (zeros)
+  CALL dm_init(test1, m,m)
+
+  !> initialize second matrix
+  !! (loop sets up data)
+  CALL dm_init(test2, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test2, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> perform matrix-matrix multiplication
+  test3 = dm_matMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_dm_mat_mul_ZERO
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct matrix-matrix multiplication (by identity matrix)
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      First (left-hand) input dense matrix (identity)
+!!  \param test2      Second (right-hand) input dense matrix
+!!  \param test3      Output matrix
+!!  \param m          Number of rows in matrices
+!!  \param n          Number of columns in matrices
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-matrix multiplication is performed
+!!  correctly for multiplication by the identity matrix for multiplication.
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_mat_mul_IDENT
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_mat_mul_IDENT'
+  TYPE(matrixT) :: test1, test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize first matrix
+  !! (loop sets up identity matrix)
+  CALL dm_init(test1, m,m)
+  DO j = 1,m
+    DO i = 1,m
+      IF (i.EQ.j) CALL dm_set(test1, i,j, 1.d0)
+    END DO
+  END DO
+
+  !> initialize second matrix
+  !! (loop sets up data)
+  CALL dm_init(test2, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test2, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> expected result is the same as the second matrix
+  expDat = test2%dat
+
+  !> perform matrix-matrix multiplication
+  test3 = dm_matMul(test1,test2)
+  CALL assertEquals(expDat,test3%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_dm_mat_mul_IDENT
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for correct matrix-matrix multiplication ( using OPERATOR (*) )
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      First (left-hand) input dense matrix
+!!  \param test2      Second (right-hand) input dense matrix
+!!  \param test3      Output matrix
+!!  \param m          Number of rows in matrices
+!!  \param n          Number of columns in matrices
+!!  \param expDat     Expected result
+!!
+!!  This test checks that matrix-matrix multiplication is performed
+!!  correctly in the general case (input matrices contain data,
+!!  but it is not of a special form). This test uses the overloaded
+!!  operator (*).
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_mat_mul_OP
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_mat_mul_OP'
+  TYPE(matrixT) :: test1, test2, test3
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(m,n) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> set up expected result
+  expDat = RESHAPE( (/ &
+                    30.d0,36.d0,42.d0,66.d0,81.d0,96.d0 &
+                    /), SHAPE(expDat) )
+
+  !> initialize first matrix (dimensions of m x m)
+  !! (loop sets up data)
+  CALL dm_init(test1, m,m)
+  DO j = 1,m
+    DO i = 1,m
+      CALL dm_set(test1, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> initialize second matrix (dimensions of m x n)
+  !! (loop sets up data)
+  CALL dm_init(test2, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test2, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> perform matrix-matrix multiplication
+  test3 = test1*test2
+  CALL assertEquals(expDat,test3%dat, m,n)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+  CALL dm_clean(test3)
+
+END SUBROUTINE test_dm_mat_mul_OP
+
+
+! ------------------------------------------------------------------------
+!>  \test Test for matrix transpose operation
+!!
+!!  \param unit_name    Name of unit test (for FRUIT)
+!!  \param test1      Input dense matrix
+!!  \param test2      Output dense matrix
+!!  \param m          Number of rows in matrices
+!!  \param n          Number of columns in matrices
+!!  \param expDat     Expected result
+! ------------------------------------------------------------------------
+SUBROUTINE test_dm_transpose
+  CHARACTER (LEN=*), PARAMETER :: unit_name = 'test_dm_transpose'
+  TYPE(matrixT) :: test1, test2
+  INTEGER, PARAMETER :: m=3,n=2
+  DOUBLE PRECISION, DIMENSION(n,m) :: expDat
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize unit test
+  CALL set_unit_name(unit_name)
+
+  !> initialize input matrix
+  !! (loop sets up data)
+  CALL dm_init(test1, m,n)
+  DO j = 1,n
+    DO i = 1,m
+      CALL dm_set(test1, i,j, ( (DBLE(j)-1.d0)*DBLE(m) + DBLE(i) ) )
+    END DO
+  END DO
+
+  !> calculate expected result (using Fortran built-in)
+  expDat = TRANSPOSE(test1%dat)
+
+  !> perform transpose operation
+  test2 = dm_transpose(test1)
+  CALL assertEquals(expDat,test2%dat, n,m)
+
+  !> deallocate matrices
+  CALL dm_clean(test1)
+  CALL dm_clean(test2)
+
+END SUBROUTINE test_dm_transpose
+
+END MODULE dense_matrix_test

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/doc-dynsws.svn-base

+# Doxyfile 1.8.0
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a hash (#) is considered a comment and will be ignored.
+# The format is:
+#       TAG = value [value, ...]
+# For lists items can also be appended using:
+#       TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (" ").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all
+# text before the first occurrence of this tag. Doxygen uses libiconv (or the
+# iconv built into libc) for the transcoding. See
+# http://www.gnu.org/software/libiconv for the list of possible encodings.
+
+DOXYFILE_ENCODING      = UTF-8
+
+# The PROJECT_NAME tag is a single word (or sequence of words) that should
+# identify the project. Note that if you do not use Doxywizard you need
+# to put quotes around the project name if it contains spaces.
+
+PROJECT_NAME           = "DynSWS"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number.
+# This could be handy for archiving the generated documentation or
+# if some version control system is used.
+
+PROJECT_NUMBER         = 1.0
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer
+# a quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF          = "Dynamic model of soil-water-structure interaction"
+
+# With the PROJECT_LOGO tag one can specify an logo or icon that is
+# included in the documentation. The maximum height of the logo should not
+# exceed 55 pixels and the maximum width should not exceed 200 pixels.
+# Doxygen will copy the logo to the output directory.
+
+PROJECT_LOGO           =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
+# base path where the generated documentation will be put.
+# If a relative path is entered, it will be relative to the location
+# where doxygen was started. If left blank the current directory will be used.
+
+OUTPUT_DIRECTORY       = doc
+
+# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
+# 4096 sub-directories (in 2 levels) under the output directory of each output
+# format and will distribute the generated files over these directories.
+# Enabling this option can be useful when feeding doxygen a huge amount of
+# source files, where putting all generated files in the same directory would
+# otherwise cause performance problems for the file system.
+
+CREATE_SUBDIRS         = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# The default language is English, other supported languages are:
+# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional,
+# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German,
+# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English
+# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian,
+# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak,
+# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese.
+
+OUTPUT_LANGUAGE        = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
+# include brief member descriptions after the members that are listed in
+# the file and class documentation (similar to JavaDoc).
+# Set to NO to disable this.
+
+BRIEF_MEMBER_DESC      = YES
+
+# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend
+# the brief description of a member or function before the detailed description.
+# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+
+REPEAT_BRIEF           = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator
+# that is used to form the text in various listings. Each string
+# in this list, if found as the leading text of the brief description, will be
+# stripped from the text and the result after processing the whole list, is
+# used as the annotated text. Otherwise, the brief description is used as-is.
+# If left blank, the following values are used ("$name" is automatically
+# replaced with the name of the entity): "The $name class" "The $name widget"
+# "The $name file" "is" "provides" "specifies" "contains"
+# "represents" "a" "an" "the"
+
+ABBREVIATE_BRIEF       =
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# Doxygen will generate a detailed section even if there is only a brief
+# description.
+
+ALWAYS_DETAILED_SEC    = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+
+INLINE_INHERITED_MEMB  = NO
+
+# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
+# path before files name in the file list and in the header files. If set
+# to NO the shortest path that makes the file name unique will be used.
+
+FULL_PATH_NAMES        = YES
+
+# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
+# can be used to strip a user-defined part of the path. Stripping is
+# only done if one of the specified strings matches the left-hand part of
+# the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the
+# path to strip.
+
+STRIP_FROM_PATH        =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
+# the path mentioned in the documentation of a class, which tells
+# the reader which header file to include in order to use a class.
+# If left blank only the name of the header file containing the class
+# definition is used. Otherwise one should specify the include paths that
+# are normally passed to the compiler using the -I flag.
+
+STRIP_FROM_INC_PATH    =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
+# (but less readable) file names. This can be useful if your file system
+# doesn't support long names like on DOS, Mac, or CD-ROM.
+
+SHORT_NAMES            = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen
+# will interpret the first line (until the first dot) of a JavaDoc-style
+# comment as the brief description. If set to NO, the JavaDoc
+# comments will behave just like regular Qt-style comments
+# (thus requiring an explicit @brief command for a brief description.)
+
+JAVADOC_AUTOBRIEF      = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then Doxygen will
+# interpret the first line (until the first dot) of a Qt-style
+# comment as the brief description. If set to NO, the comments
+# will behave just like regular Qt-style comments (thus requiring
+# an explicit \brief command for a brief description.)
+
+QT_AUTOBRIEF           = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen
+# treat a multi-line C++ special comment block (i.e. a block of //! or ///
+# comments) as a brief description. This used to be the default behaviour.
+# The new default is to treat a multi-line C++ comment block as a detailed
+# description. Set this tag to YES if you prefer the old behaviour instead.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
+# member inherits the documentation from any documented member that it
+# re-implements.
+
+INHERIT_DOCS           = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce
+# a new page for each member. If set to NO, the documentation of a member will
+# be part of the file/class/namespace that contains it.
+
+SEPARATE_MEMBER_PAGES  = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab.
+# Doxygen uses this value to replace tabs by spaces in code fragments.
+
+TAB_SIZE               = 2
+
+# This tag can be used to specify a number of aliases that acts
+# as commands in the documentation. An alias has the form "name=value".
+# For example adding "sideeffect=\par Side Effects:\n" will allow you to
+# put the command \sideeffect (or @sideeffect) in the documentation, which
+# will result in a user-defined paragraph with heading "Side Effects:".
+# You can put \n's in the value part of an alias to insert newlines.
+
+ALIASES                =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding
+# "class=itcl::class" will allow you to use the command class in the
+# itcl::class meaning.
+
+TCL_SUBST              =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
+# sources only. Doxygen will then generate output that is more tailored for C.
+# For instance, some of the names that are used will be different. The list
+# of all members will be omitted, etc.
+
+OPTIMIZE_OUTPUT_FOR_C  = NO
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java
+# sources only. Doxygen will then generate output that is more tailored for
+# Java. For instance, namespaces will be presented as packages, qualified
+# scopes will look different, etc.
+
+OPTIMIZE_OUTPUT_JAVA   = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources only. Doxygen will then generate output that is more tailored for
+# Fortran.
+
+OPTIMIZE_FOR_FORTRAN   = YES
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for
+# VHDL.
+
+OPTIMIZE_OUTPUT_VHDL   = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given extension.
+# Doxygen has a built-in mapping, but you can override or extend it using this
+# tag. The format is ext=language, where ext is a file extension, and language
+# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C,
+# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make
+# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C
+# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
+# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
+
+EXTENSION_MAPPING      =
+
+# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
+# comments according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you
+# can mix doxygen, HTML, and XML commands with Markdown formatting.
+# Disable only in case of backward compatibilities issues.
+
+MARKDOWN_SUPPORT       = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also makes the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT    = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+
+CPP_CLI_SUPPORT        = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only.
+# Doxygen will parse them like normal C++ but will assume all classes use public
+# instead of private inheritance when no explicit protection keyword is present.
+
+SIP_SUPPORT            = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate getter
+# and setter methods for a property. Setting this option to YES (the default)
+# will make doxygen replace the get and set methods by a property in the
+# documentation. This will only work if the methods are indeed getting or
+# setting a simple type. If this is not the case, or you want to show the
+# methods anyway, you should set this option to NO.
+
+IDL_PROPERTY_SUPPORT   = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES, then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+
+DISTRIBUTE_GROUP_DOC   = NO
+
+# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
+# the same type (for instance a group of public functions) to be put as a
+# subgroup of that type (e.g. under the Public Functions section). Set it to
+# NO to prevent subgrouping. Alternatively, this can be done per class using
+# the \nosubgrouping command.
+
+SUBGROUPING            = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and
+# unions are shown inside the group in which they are included (e.g. using
+# @ingroup) instead of on a separate page (for HTML and Man pages) or
+# section (for LaTeX and RTF).
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and
+# unions with only public data fields will be shown inline in the documentation
+# of the scope in which they are defined (i.e. file, namespace, or group
+# documentation), provided this scope is documented. If set to NO (the default),
+# structs, classes, and unions are shown on a separate page (for HTML and Man
+# pages) or section (for LaTeX and RTF).
+
+INLINE_SIMPLE_STRUCTS  = NO
+
+# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum
+# is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically
+# be useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+
+TYPEDEF_HIDES_STRUCT   = NO
+
+# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
+# determine which symbols to keep in memory and which to flush to disk.
+# When the cache is full, less often used symbols will be written to disk.
+# For small to medium size projects (<1000 input files) the default value is
+# probably good enough. For larger projects a too small cache size can cause
+# doxygen to be busy swapping symbols to and from disk most of the time
+# causing a significant performance penalty.
+# If the system has enough physical memory increasing the cache will improve the
+# performance by keeping more symbols in memory. Note that the value works on
+# a logarithmic scale so increasing the size by one will roughly double the
+# memory usage. The cache size is given by this formula:
+# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+SYMBOL_CACHE_SIZE      = 0
+
+# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
+# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
+# their name and scope. Since this can be an expensive process and often the
+# same symbol appear multiple times in the code, doxygen keeps a cache of
+# pre-resolved symbols. If the cache is too small doxygen will become slower.
+# If the cache is too large, memory is wasted. The cache size is given by this
+# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0,
+# corresponding to a cache size of 2^16 = 65536 symbols.
+
+LOOKUP_CACHE_SIZE      = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in
+# documentation are documented, even if no documentation was available.
+# Private class members and static file members will be hidden unless
+# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
+
+EXTRACT_ALL            = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
+# will be included in the documentation.
+
+EXTRACT_PRIVATE        = YES
+
+# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
+
+EXTRACT_PACKAGE        = YES
+
+# If the EXTRACT_STATIC tag is set to YES all static members of a file
+# will be included in the documentation.
+
+EXTRACT_STATIC         = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
+# defined locally in source files will be included in the documentation.
+# If set to NO only classes defined in header files are included.
+
+EXTRACT_LOCAL_CLASSES  = YES
+
+# This flag is only useful for Objective-C code. When set to YES local
+# methods, which are defined in the implementation section but not in
+# the interface are included in the documentation.
+# If set to NO (the default) only methods in the interface are included.
+
+EXTRACT_LOCAL_METHODS  = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base
+# name of the file that contains the anonymous namespace. By default
+# anonymous namespaces are hidden.
+
+EXTRACT_ANON_NSPACES   = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
+# undocumented members of documented classes, files or namespaces.
+# If set to NO (the default) these members will be included in the
+# various overviews, but no documentation section is generated.
+# This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_MEMBERS     = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy.
+# If set to NO (the default) these classes will be included in the various
+# overviews. This option has no effect if EXTRACT_ALL is enabled.
+
+HIDE_UNDOC_CLASSES     = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all
+# friend (class|struct|union) declarations.
+# If set to NO (the default) these declarations will be included in the
+# documentation.
+
+HIDE_FRIEND_COMPOUNDS  = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any
+# documentation blocks found inside the body of a function.
+# If set to NO (the default) these blocks will be appended to the
+# function's detailed documentation block.
+
+HIDE_IN_BODY_DOCS      = NO
+
+# The INTERNAL_DOCS tag determines if documentation
+# that is typed after a \internal command is included. If the tag is set
+# to NO (the default) then the documentation will be excluded.
+# Set it to YES to include the internal documentation.
+
+INTERNAL_DOCS          = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate
+# file names in lower-case letters. If set to YES upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+
+CASE_SENSE_NAMES       = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen
+# will show members with their full class and namespace scopes in the
+# documentation. If set to YES the scope will be hidden.
+
+HIDE_SCOPE_NAMES       = NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen
+# will put a list of the files that are included by a file in the documentation
+# of that file.
+
+SHOW_INCLUDE_FILES     = YES
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen
+# will list include files with double quotes in the documentation
+# rather than with sharp brackets.
+
+FORCE_LOCAL_INCLUDES   = NO
+
+# If the INLINE_INFO tag is set to YES (the default) then a tag [inline]
+# is inserted in the documentation for inline members.
+
+INLINE_INFO            = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen
+# will sort the (detailed) documentation of file and class members
+# alphabetically by member name. If set to NO the members will appear in
+# declaration order.
+
+SORT_MEMBER_DOCS       = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the
+# brief documentation of file, namespace and class members alphabetically
+# by member name. If set to NO (the default) the members will appear in
+# declaration order.
+
+SORT_BRIEF_DOCS        = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen
+# will sort the (brief and detailed) documentation of class members so that
+# constructors and destructors are listed first. If set to NO (the default)
+# the constructors will appear in the respective orders defined by
+# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS.
+# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO
+# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the
+# hierarchy of group names into alphabetical order. If set to NO (the default)
+# the group names will appear in their defined order.
+
+SORT_GROUP_NAMES       = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be
+# sorted by fully-qualified names, including namespaces. If set to
+# NO (the default), the class list will be sorted only by class name,
+# not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the
+# alphabetical list.
+
+SORT_BY_SCOPE_NAME     = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to
+# do proper type resolution of all parameters of a function it will reject a
+# match between the prototype and the implementation of a member function even
+# if there is only one candidate or it is obvious which candidate to choose
+# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen
+# will still accept a match between prototype and implementation in such cases.
+
+STRICT_PROTO_MATCHING  = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or
+# disable (NO) the todo list. This list is created by putting \todo
+# commands in the documentation.
+
+GENERATE_TODOLIST      = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or
+# disable (NO) the test list. This list is created by putting \test
+# commands in the documentation.
+
+GENERATE_TESTLIST      = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or
+# disable (NO) the bug list. This list is created by putting \bug
+# commands in the documentation.
+
+GENERATE_BUGLIST       = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or
+# disable (NO) the deprecated list. This list is created by putting
+# \deprecated commands in the documentation.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional
+# documentation sections, marked by \if sectionname ... \endif.
+
+ENABLED_SECTIONS       =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines
+# the initial value of a variable or macro consists of for it to appear in
+# the documentation. If the initializer consists of more lines than specified
+# here it will be hidden. Use a value of 0 to hide initializers completely.
+# The appearance of the initializer of individual variables and macros in the
+# documentation can be controlled using \showinitializer or \hideinitializer
+# command in the documentation regardless of this setting.
+
+MAX_INITIALIZER_LINES  = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated
+# at the bottom of the documentation of classes and structs. If set to YES the
+# list will mention the files that were used to generate the documentation.
+
+SHOW_USED_FILES        = YES
+
+# If the sources in your project are distributed over multiple directories
+# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy
+# in the documentation. The default is NO.
+
+SHOW_DIRECTORIES       = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page.
+# This will remove the Files entry from the Quick Index and from the
+# Folder Tree View (if specified). The default is YES.
+
+SHOW_FILES             = YES
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the
+# Namespaces page.
+# This will remove the Namespaces entry from the Quick Index
+# and from the Folder Tree View (if specified). The default is YES.
+
+SHOW_NAMESPACES        = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command <command> <input-file>, where <command> is the value of
+# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file
+# provided by doxygen. Whatever the program writes to standard output
+# is used as the file version. See the manual for examples.
+
+FILE_VERSION_FILTER    =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. The create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option.
+# You can optionally specify a file name after the option, if omitted
+# DoxygenLayout.xml will be used as the name of the layout file.
+
+LAYOUT_FILE            =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files
+# containing the references data. This must be a list of .bib files. The
+# .bib extension is automatically appended if omitted. Using this command
+# requires the bibtex tool to be installed. See also
+# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style
+# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this
+# feature you need bibtex and perl available in the search path.
+
+CITE_BIB_FILES         =
+
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated
+# by doxygen. Possible values are YES and NO. If left blank NO is used.
+
+QUIET                  = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated by doxygen. Possible values are YES and NO. If left blank
+# NO is used.
+
+WARNINGS               = YES
+
+# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
+# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
+# automatically be disabled.
+
+WARN_IF_UNDOCUMENTED   = YES
+
+# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some
+# parameters in a documented function, or documenting parameters that
+# don't exist or using markup commands wrongly.
+
+WARN_IF_DOC_ERROR      = YES
+
+# The WARN_NO_PARAMDOC option can be enabled to get warnings for
+# functions that are documented, but have no documentation for their parameters
+# or return value. If set to NO (the default) doxygen will only warn about
+# wrong or incomplete parameter documentation, but not about the absence of
+# documentation.
+
+WARN_NO_PARAMDOC       = NO
+
+# The WARN_FORMAT tag determines the format of the warning messages that
+# doxygen can produce. The string should contain the $file, $line, and $text
+# tags, which will be replaced by the file and line number from which the
+# warning originated and the warning text. Optionally the format may contain
+# $version, which will be replaced by the version of the file (if it could
+# be obtained via FILE_VERSION_FILTER)
+
+WARN_FORMAT            = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning
+# and error messages should be written. If left blank the output is written
+# to stderr.
+
+WARN_LOGFILE           = "doc_log.txt"
+
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag can be used to specify the files and/or directories that contain
+# documented source files. You may enter file names like "myfile.cpp" or
+# directories like "/usr/src/myproject". Separate the files or directories
+# with spaces.
+
+INPUT                  =
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
+# also the default input encoding. Doxygen uses libiconv (or the iconv built
+# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for
+# the list of possible encodings.
+
+INPUT_ENCODING         = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank the following patterns are tested:
+# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh
+# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
+# *.f90 *.f *.for *.vhd *.vhdl
+
+FILE_PATTERNS          =
+
+# The RECURSIVE tag can be used to turn specify whether or not subdirectories
+# should be searched for input files as well. Possible values are YES and NO.
+# If left blank NO is used.
+
+RECURSIVE              = NO
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE                = Makefile test_driver.exe fruit.f90 fruit_util.f90
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+
+EXCLUDE_SYMLINKS       = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories. Note that the wildcards are matched
+# against the file with absolute path, so to exclude all test directories
+# for example use the pattern */test/*
+
+EXCLUDE_PATTERNS       =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+
+EXCLUDE_SYMBOLS        =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or
+# directories that contain example code fragments that are included (see
+# the \include command).
+
+EXAMPLE_PATH           =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
+# and *.h) to filter out the source-files in the directories. If left
+# blank all files are included.
+
+EXAMPLE_PATTERNS       =
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude
+# commands irrespective of the value of the RECURSIVE tag.
+# Possible values are YES and NO. If left blank NO is used.
+
+EXAMPLE_RECURSIVE      = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or
+# directories that contain image that are included in the documentation (see
+# the \image command).
+
+IMAGE_PATH             =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command <filter> <input-file>, where <filter>
+# is the value of the INPUT_FILTER tag, and <input-file> is the name of an
+# input file. Doxygen will then use the output that the filter program writes
+# to standard output.
+# If FILTER_PATTERNS is specified, this tag will be
+# ignored.
+
+INPUT_FILTER           =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis.
+# Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match.
+# The filters are a list of the form:
+# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further
+# info on how filters are used. If FILTER_PATTERNS is empty or if
+# non of the patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS        =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will be used to filter the input files when producing source
+# files to browse (i.e. when SOURCE_BROWSER is set to YES).
+
+FILTER_SOURCE_FILES    = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any)
+# and it is also possible to disable source filtering for a specific pattern
+# using *.ext= (so without naming a filter). This option only has effect when
+# FILTER_SOURCE_FILES is enabled.
+
+FILTER_SOURCE_PATTERNS =
+
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will
+# be generated. Documented entities will be cross-referenced with these sources.
+# Note: To get rid of all source code in the generated output, make sure also
+# VERBATIM_HEADERS is set to NO.
+
+SOURCE_BROWSER         = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body
+# of functions and classes directly in the documentation.
+
+INLINE_SOURCES         = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
+# doxygen to hide any special comment blocks from generated source code
+# fragments. Normal C and C++ comments will always remain visible.
+
+STRIP_CODE_COMMENTS    = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES
+# then for each documented function all documented
+# functions referencing it will be listed.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES
+# then for each documented function all documented entities
+# called/used by that function will be listed.
+
+REFERENCES_RELATION    = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES (the default)
+# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from
+# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will
+# link to the source code.
+# Otherwise they will link to the documentation.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code
+# will point to the HTML generated by the htags(1) tool instead of doxygen
+# built-in source browser. The htags tool is part of GNU's global source
+# tagging system (see http://www.gnu.org/software/global/global.html). You
+# will need version 4.8.6 or higher.
+
+USE_HTAGS              = NO
+
+# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen
+# will generate a verbatim copy of the header file for each class for
+# which an include is specified. Set to NO to disable this.
+
+VERBATIM_HEADERS       = YES
+
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index
+# of all compounds will be generated. Enable this if the project
+# contains a lot of classes, structs, unions or interfaces.
+
+ALPHABETICAL_INDEX     = YES
+
+# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
+# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
+# in which this list will be split (can be a number in the range [1..20])
+
+COLS_IN_ALPHA_INDEX    = 5
+
+# In case all classes in a project start with a common prefix, all
+# classes will be put under the same header in the alphabetical index.
+# The IGNORE_PREFIX tag can be used to specify one or more prefixes that
+# should be ignored while generating the index headers.
+
+IGNORE_PREFIX          =
+
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES (the default) Doxygen will
+# generate HTML output.
+
+GENERATE_HTML          = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `html' will be used as the default path.
+
+HTML_OUTPUT            = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for
+# each generated HTML page (for example: .htm,.php,.asp). If it is left blank
+# doxygen will generate files with .html extension.
+
+HTML_FILE_EXTENSION    = .html
+
+# The HTML_HEADER tag can be used to specify a personal HTML header for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard header. Note that when using a custom header you are responsible
+#  for the proper inclusion of any scripts and style sheets that doxygen
+# needs, which is dependent on the configuration options used.
+# It is advised to generate a default header using "doxygen -w html
+# header.html footer.html stylesheet.css YourConfigFile" and then modify
+# that header. Note that the header is subject to change so you typically
+# have to redo this when upgrading to a newer version of doxygen or when
+# changing the value of configuration settings such as GENERATE_TREEVIEW!
+
+HTML_HEADER            =
+
+# The HTML_FOOTER tag can be used to specify a personal HTML footer for
+# each generated HTML page. If it is left blank doxygen will generate a
+# standard footer.
+
+HTML_FOOTER            =
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
+# style sheet that is used by each HTML page. It can be used to
+# fine-tune the look of the HTML output. If the tag is left blank doxygen
+# will generate a default style sheet. Note that doxygen will try to copy
+# the style sheet file to the HTML output directory, so don't put your own
+# style sheet in the HTML output directory as well, or it will be erased!
+
+HTML_STYLESHEET        =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that
+# the files will be copied as-is; there are no commands or markers available.
+
+HTML_EXTRA_FILES       =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
+# Doxygen will adjust the colors in the style sheet and background images
+# according to this color. Hue is specified as an angle on a colorwheel,
+# see http://en.wikipedia.org/wiki/Hue for more information.
+# For instance the value 0 represents red, 60 is yellow, 120 is green,
+# 180 is cyan, 240 is blue, 300 purple, and 360 is red again.
+# The allowed range is 0 to 359.
+
+HTML_COLORSTYLE_HUE    = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of
+# the colors in the HTML output. For a value of 0 the output will use
+# grayscales only. A value of 255 will produce the most vivid colors.
+
+HTML_COLORSTYLE_SAT    = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to
+# the luminance component of the colors in the HTML output. Values below
+# 100 gradually make the output lighter, whereas values above 100 make
+# the output darker. The value divided by 100 is the actual gamma applied,
+# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
+# and 100 does not change the gamma.
+
+HTML_COLORSTYLE_GAMMA  = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting
+# this to NO can help when comparing the output of multiple runs.
+
+HTML_TIMESTAMP         = YES
+
+# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
+# files or namespaces will be aligned in HTML using tables. If set to
+# NO a bullet list will be used.
+
+HTML_ALIGN_MEMBERS     = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded. For this to work a browser that supports
+# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox
+# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari).
+
+HTML_DYNAMIC_SECTIONS  = NO
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files
+# will be generated that can be used as input for Apple's Xcode 3
+# integrated development environment, introduced with OSX 10.5 (Leopard).
+# To create a documentation set, doxygen will generate a Makefile in the
+# HTML output directory. Running make will produce the docset in that
+# directory and running "make install" will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
+# it at startup.
+# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+
+GENERATE_DOCSET        = NO
+
+# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
+# feed. A documentation feed provides an umbrella under which multiple
+# documentation sets from a single provider (such as a company or product suite)
+# can be grouped.
+
+DOCSET_FEEDNAME        = "Doxygen generated docs"
+
+# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
+# should uniquely identify the documentation set bundle. This should be a
+# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
+# will append .docset to the name.
+
+DOCSET_BUNDLE_ID       = org.doxygen.Project
+
+# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+
+DOCSET_PUBLISHER_ID    = org.doxygen.Publisher
+
+# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher.
+
+DOCSET_PUBLISHER_NAME  = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES, additional index files
+# will be generated that can be used as input for tools like the
+# Microsoft HTML help workshop to generate a compiled HTML help file (.chm)
+# of the generated HTML documentation.
+
+GENERATE_HTMLHELP      = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can
+# be used to specify the file name of the resulting .chm file. You
+# can add a path in front of the file if the result should not be
+# written to the html output directory.
+
+CHM_FILE               =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
+# be used to specify the location (absolute path including file name) of
+# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
+# the HTML help compiler on the generated index.hhp.
+
+HHC_LOCATION           =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
+# controls if a separate .chi index file is generated (YES) or that
+# it should be included in the master .chm file (NO).
+
+GENERATE_CHI           = NO
+
+# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING
+# is used to encode HtmlHelp index (hhk), content (hhc) and project file
+# content.
+
+CHM_INDEX_ENCODING     =
+
+# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag
+# controls whether a binary table of contents is generated (YES) or a
+# normal table of contents (NO) in the .chm file.
+
+BINARY_TOC             = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members
+# to the contents of the HTML help documentation and to the tree view.
+
+TOC_EXPAND             = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated
+# that can be used as input for Qt's qhelpgenerator to generate a
+# Qt Compressed Help (.qch) of the generated HTML documentation.
+
+GENERATE_QHP           = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can
+# be used to specify the file name of the resulting .qch file.
+# The path specified is relative to the HTML output folder.
+
+QCH_FILE               =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#namespace
+
+QHP_NAMESPACE          = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating
+# Qt Help Project output. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#virtual-folders
+
+QHP_VIRTUAL_FOLDER     = doc
+
+# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to
+# add. For more information please see
+# http://doc.trolltech.com/qthelpproject.html#custom-filters
+
+QHP_CUST_FILTER_NAME   =
+
+# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see
+# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">
+# Qt Help Project / Custom Filters</a>.
+
+QHP_CUST_FILTER_ATTRS  =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's
+# filter section matches.
+# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">
+# Qt Help Project / Filter Attributes</a>.
+
+QHP_SECT_FILTER_ATTRS  =
+
+# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can
+# be used to specify the location of Qt's qhelpgenerator.
+# If non-empty doxygen will try to run qhelpgenerator on the generated
+# .qhp file.
+
+QHG_LOCATION           =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files
+#  will be generated, which together with the HTML files, form an Eclipse help
+# plugin. To install this plugin and make it available under the help contents
+# menu in Eclipse, the contents of the directory containing the HTML and XML
+# files needs to be copied into the plugins directory of eclipse. The name of
+# the directory within the plugins directory should be the same as
+# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before
+# the help appears.
+
+GENERATE_ECLIPSEHELP   = NO
+
+# A unique identifier for the eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have
+# this name.
+
+ECLIPSE_DOC_ID         = org.doxygen.Project
+
+# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs)
+# at top of each HTML page. The value NO (the default) enables the index and
+# the value YES disables it. Since the tabs have the same information as the
+# navigation tree you can set this option to NO if you already set
+# GENERATE_TREEVIEW to YES.
+
+DISABLE_INDEX          = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information.
+# If the tag value is set to YES, a side panel will be generated
+# containing a tree-like index structure (just like the one that
+# is generated for HTML Help). For this to work a browser that supports
+# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
+# Windows users are probably better off using the HTML help feature.
+# Since the tree basically has the same information as the tab index you
+# could consider to set DISABLE_INDEX to NO when enabling this option.
+
+GENERATE_TREEVIEW      = NO
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
+# (range [0,1..20]) that doxygen will group on one line in the generated HTML
+# documentation. Note that a value of 0 will completely suppress the enum
+# values from appearing in the overview section.
+
+ENUM_VALUES_PER_LINE   = 4
+
+# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
+# and Class Hierarchy pages using a tree view instead of an ordered list.
+
+USE_INLINE_TREES       = NO
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be
+# used to set the initial width (in pixels) of the frame in which the tree
+# is shown.
+
+TREEVIEW_WIDTH         = 250
+
+# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
+# links to external symbols imported via tag files in a separate window.
+
+EXT_LINKS_IN_WINDOW    = NO
+
+# Use this tag to change the font size of Latex formulas included
+# as images in the HTML documentation. The default is 10. Note that
+# when you change the font size after a successful doxygen run you need
+# to manually remove any form_*.png images from the HTML output directory
+# to force them to be regenerated.
+
+FORMULA_FONTSIZE       = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are
+# not supported properly for IE 6.0, but are supported on all modern browsers.
+# Note that when changing this option you need to delete any form_*.png files
+# in the HTML output before the changes have effect.
+
+FORMULA_TRANSPARENT    = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax
+# (see http://www.mathjax.org) which uses client side Javascript for the
+# rendering instead of using prerendered bitmaps. Use this if you do not
+# have LaTeX installed or if you want to formulas look prettier in the HTML
+# output. When enabled you may also need to install MathJax separately and
+# configure the path to it using the MATHJAX_RELPATH option.
+
+USE_MATHJAX            = NO
+
+# When MathJax is enabled you need to specify the location relative to the
+# HTML output directory using the MATHJAX_RELPATH option. The destination
+# directory should contain the MathJax.js script. For instance, if the mathjax
+# directory is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to
+# the MathJax Content Delivery Network so you can quickly see the result without
+# installing MathJax.
+# However, it is strongly recommended to install a local
+# copy of MathJax from http://www.mathjax.org before deployment.
+
+MATHJAX_RELPATH        = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension
+# names that should be enabled during MathJax rendering.
+
+MATHJAX_EXTENSIONS     =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box
+# for the HTML output. The underlying search engine uses javascript
+# and DHTML and should work on any modern browser. Note that when using
+# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets
+# (GENERATE_DOCSET) there is already a search function so this one should
+# typically be disabled. For large projects the javascript based search engine
+# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution.
+
+SEARCHENGINE           = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a PHP enabled web server instead of at the web client
+# using Javascript. Doxygen will generate the search PHP script and index
+# file to put on the web server. The advantage of the server
+# based approach is that it scales better to large projects and allows
+# full text search. The disadvantages are that it is more difficult to setup
+# and does not have live searching capabilities.
+
+SERVER_BASED_SEARCH    = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
+# generate Latex output.
+
+GENERATE_LATEX         = YES
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `latex' will be used as the default path.
+
+LATEX_OUTPUT           = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked. If left blank `latex' will be used as the default command name.
+# Note that when enabling USE_PDFLATEX this option is only used for
+# generating bitmaps for formulas in the HTML output, but not in the
+# Makefile that is written to the output directory.
+
+LATEX_CMD_NAME         = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
+# generate index for LaTeX. If left blank `makeindex' will be used as the
+# default command name.
+
+MAKEINDEX_CMD_NAME     = makeindex
+
+# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
+# LaTeX documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_LATEX          = NO
+
+# The PAPER_TYPE tag can be used to set the paper type that is used
+# by the printer. Possible values are: a4, letter, legal and
+# executive. If left blank a4wide will be used.
+
+PAPER_TYPE             = letter
+
+# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
+# packages that should be included in the LaTeX output.
+
+EXTRA_PACKAGES         =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for
+# the generated latex document. The header should contain everything until
+# the first chapter. If it is left blank doxygen will generate a
+# standard header. Notice: only use this tag if you know what you are doing!
+
+LATEX_HEADER           =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
+# the generated latex document. The footer should contain everything after
+# the last chapter. If it is left blank doxygen will generate a
+# standard footer. Notice: only use this tag if you know what you are doing!
+
+LATEX_FOOTER           =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
+# is prepared for conversion to pdf (using ps2pdf). The pdf file will
+# contain links (just like the HTML output) instead of page references
+# This makes the output suitable for online browsing using a pdf viewer.
+
+PDF_HYPERLINKS         = YES
+
+# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
+# plain latex in the generated Makefile. Set this option to YES to get a
+# higher quality PDF documentation.
+
+USE_PDFLATEX           = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
+# command to the generated LaTeX files. This will instruct LaTeX to keep
+# running if errors occur, instead of asking the user for help.
+# This option is also used when generating formulas in HTML.
+
+LATEX_BATCHMODE        = NO
+
+# If LATEX_HIDE_INDICES is set to YES then doxygen will not
+# include the index chapters (such as File Index, Compound Index, etc.)
+# in the output.
+
+LATEX_HIDE_INDICES     = NO
+
+# If LATEX_SOURCE_CODE is set to YES then doxygen will include
+# source code with syntax highlighting in the LaTeX output.
+# Note that which sources are shown also depends on other settings
+# such as SOURCE_BROWSER.
+
+LATEX_SOURCE_CODE      = NO
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
+# http://en.wikipedia.org/wiki/BibTeX for more info.
+
+LATEX_BIB_STYLE        = ieeetran
+
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output
+# The RTF output is optimized for Word 97 and may not look very pretty with
+# other RTF readers or editors.
+
+GENERATE_RTF           = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `rtf' will be used as the default path.
+
+RTF_OUTPUT             = rtf
+
+# If the COMPACT_RTF tag is set to YES Doxygen generates more compact
+# RTF documents. This may be useful for small projects and may help to
+# save some trees in general.
+
+COMPACT_RTF            = NO
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated
+# will contain hyperlink fields. The RTF file will
+# contain links (just like the HTML output) instead of page references.
+# This makes the output suitable for online browsing using WORD or other
+# programs which support those fields.
+# Note: wordpad (write) and others do not support links.
+
+RTF_HYPERLINKS         = NO
+
+# Load style sheet definitions from file. Syntax is similar to doxygen's
+# config file, i.e. a series of assignments. You only have to provide
+# replacements, missing definitions are set to their default value.
+
+RTF_STYLESHEET_FILE    =
+
+# Set optional variables used in the generation of an rtf document.
+# Syntax is similar to doxygen's config file.
+
+RTF_EXTENSIONS_FILE    =
+
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES (the default) Doxygen will
+# generate man pages
+
+GENERATE_MAN           = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `man' will be used as the default path.
+
+MAN_OUTPUT             = man
+
+# The MAN_EXTENSION tag determines the extension that is added to
+# the generated man pages (default is the subroutine's section .3)
+
+MAN_EXTENSION          = .3
+
+# If the MAN_LINKS tag is set to YES and Doxygen generates man output,
+# then it will generate one additional man file for each entity
+# documented in the real man page(s). These additional files
+# only source the real man page, but without them the man command
+# would be unable to find the correct page. The default is NO.
+
+MAN_LINKS              = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES Doxygen will
+# generate an XML file that captures the structure of
+# the code including all documentation.
+
+GENERATE_XML           = NO
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be
+# put in front of it. If left blank `xml' will be used as the default path.
+
+XML_OUTPUT             = xml
+
+# The XML_SCHEMA tag can be used to specify an XML schema,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_SCHEMA             =
+
+# The XML_DTD tag can be used to specify an XML DTD,
+# which can be used by a validating XML parser to check the
+# syntax of the XML files.
+
+XML_DTD                =
+
+# If the XML_PROGRAMLISTING tag is set to YES Doxygen will
+# dump the program listings (including syntax highlighting
+# and cross-referencing information) to the XML output. Note that
+# enabling this will significantly increase the size of the XML output.
+
+XML_PROGRAMLISTING     = YES
+
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will
+# generate an AutoGen Definitions (see autogen.sf.net) file
+# that captures the structure of the code including all
+# documentation. Note that this feature is still experimental
+# and incomplete at the moment.
+
+GENERATE_AUTOGEN_DEF   = NO
+
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES Doxygen will
+# generate a Perl module file that captures the structure of
+# the code including all documentation. Note that this
+# feature is still experimental and incomplete at the
+# moment.
+
+GENERATE_PERLMOD       = NO
+
+# If the PERLMOD_LATEX tag is set to YES Doxygen will generate
+# the necessary Makefile rules, Perl scripts and LaTeX code to be able
+# to generate PDF and DVI output from the Perl module output.
+
+PERLMOD_LATEX          = NO
+
+# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be
+# nicely formatted so it can be parsed by a human reader.
+# This is useful
+# if you want to understand what is going on.
+# On the other hand, if this
+# tag is set to NO the size of the Perl module output will be much smaller
+# and Perl will parse it just the same.
+
+PERLMOD_PRETTY         = YES
+
+# The names of the make variables in the generated doxyrules.make file
+# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX.
+# This is useful so different doxyrules.make files included by the same
+# Makefile don't overwrite each other's variables.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
+# evaluate all C-preprocessor directives found in the sources and include
+# files.
+
+ENABLE_PREPROCESSING   = YES
+
+# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
+# names in the source code. If set to NO (the default) only conditional
+# compilation will be performed. Macro expansion can be done in a controlled
+# way by setting EXPAND_ONLY_PREDEF to YES.
+
+MACRO_EXPANSION        = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
+# then the macro expansion is limited to the macros specified with the
+# PREDEFINED and EXPAND_AS_DEFINED tags.
+
+EXPAND_ONLY_PREDEF     = NO
+
+# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
+# pointed to by INCLUDE_PATH will be searched when a #include is found.
+
+SEARCH_INCLUDES        = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by
+# the preprocessor.
+
+INCLUDE_PATH           =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will
+# be used.
+
+INCLUDE_FILE_PATTERNS  =
+
+# The PREDEFINED tag can be used to specify one or more macro names that
+# are defined before the preprocessor is started (similar to the -D option of
+# gcc). The argument of the tag is a list of macros of the form: name
+# or name=definition (no spaces). If the definition and the = are
+# omitted =1 is assumed. To prevent a macro definition from being
+# undefined via #undef or recursively expanded use the := operator
+# instead of the = operator.
+
+PREDEFINED             =
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
+# this tag can be used to specify a list of macro names that should be expanded.
+# The macro definition that is found in the sources will be used.
+# Use the PREDEFINED tag if you want to use a different macro definition that
+# overrules the definition found in the source code.
+
+EXPAND_AS_DEFINED      =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
+# doxygen's preprocessor will remove all references to function-like macros
+# that are alone on a line, have an all uppercase name, and do not end with a
+# semicolon, because these will confuse the parser if not removed.
+
+SKIP_FUNCTION_MACROS   = YES
+
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES option can be used to specify one or more tagfiles. For each
+# tag file the location of the external documentation should be added. The
+# format of a tag file without this location is as follows:
+#
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+#
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where "loc1" and "loc2" can be relative or absolute paths
+# or URLs. Note that each tag file must have a unique name (where the name does
+# NOT include the path). If a tag file is not located in the directory in which
+# doxygen is run, you must also specify the path to the tagfile here.
+
+TAGFILES               =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create
+# a tag file that is based on the input files it reads.
+
+GENERATE_TAGFILE       =
+
+# If the ALLEXTERNALS tag is set to YES all external classes will be listed
+# in the class index. If set to NO only the inherited external classes
+# will be listed.
+
+ALLEXTERNALS           = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will
+# be listed.
+
+EXTERNAL_GROUPS        = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of `which perl').
+
+PERL_PATH              = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
+# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
+# or super classes. Setting the tag to NO turns the diagrams off. Note that
+# this option also works with HAVE_DOT disabled, but it is recommended to
+# install and use dot, since it yields more powerful graphs.
+
+CLASS_DIAGRAMS         = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see
+# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH            =
+
+# If set to YES, the inheritance and collaboration graphs will hide
+# inheritance and usage relations if the target is undocumented
+# or is not a class.
+
+HIDE_UNDOC_RELATIONS   = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz, a graph visualization
+# toolkit from AT&T and Lucent Bell Labs. The other options in this section
+# have no effect if this option is set to NO (the default)
+
+HAVE_DOT               = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
+# allowed to run in parallel. When set to 0 (the default) doxygen will
+# base this on the number of processors available in the system. You can set it
+# explicitly to a value larger than 0 to get control over the balance
+# between CPU load and processing speed.
+
+DOT_NUM_THREADS        = 0
+
+# By default doxygen will use the Helvetica font for all dot files that
+# doxygen generates. When you want a differently looking font you can specify
+# the font name using DOT_FONTNAME. You need to make sure dot is able to find
+# the font, which can be done by putting it in a standard location or by setting
+# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
+# directory containing the font.
+
+DOT_FONTNAME           = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
+# The default size is 10pt.
+
+DOT_FONTSIZE           = 10
+
+# By default doxygen will tell dot to use the Helvetica font.
+# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
+# set the path where dot can find it.
+
+DOT_FONTPATH           =
+
+# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect inheritance relations. Setting this tag to YES will force the
+# CLASS_DIAGRAMS tag to NO.
+
+CLASS_GRAPH            = YES
+
+# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for each documented class showing the direct and
+# indirect implementation dependencies (inheritance, containment, and
+# class references variables) of the class with other documented classes.
+
+COLLABORATION_GRAPH    = YES
+
+# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
+# will generate a graph for groups, showing the direct groups dependencies
+
+GROUP_GRAPHS           = YES
+
+# If the UML_LOOK tag is set to YES doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+
+UML_LOOK               = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside
+# the class node. If there are many fields or methods and many nodes the
+# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
+# threshold limits the number of items for each type to make the size more
+# managable. Set this to 0 for no limit. Note that the threshold may be
+# exceeded by 50% before the limit is enforced.
+
+UML_LIMIT_NUM_FIELDS   = 10
+
+# If set to YES, the inheritance and collaboration graphs will show the
+# relations between templates and their instances.
+
+TEMPLATE_RELATIONS     = NO
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
+# tags are set to YES then doxygen will generate a graph for each documented
+# file showing the direct and indirect include dependencies of the file with
+# other documented files.
+
+INCLUDE_GRAPH          = YES
+
+# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
+# HAVE_DOT tags are set to YES then doxygen will generate a graph for each
+# documented header file showing the documented files that directly or
+# indirectly include this file.
+
+INCLUDED_BY_GRAPH      = YES
+
+# If the CALL_GRAPH and HAVE_DOT options are set to YES then
+# doxygen will generate a call dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable call graphs
+# for selected functions only using the \callgraph command.
+
+CALL_GRAPH             = NO
+
+# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
+# doxygen will generate a caller dependency graph for every global function
+# or class method. Note that enabling this option will significantly increase
+# the time of a run. So in most cases it will be better to enable caller
+# graphs for selected functions only using the \callergraph command.
+
+CALLER_GRAPH           = NO
+
+# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
+# will generate a graphical hierarchy of all classes instead of a textual one.
+
+GRAPHICAL_HIERARCHY    = YES
+
+# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES
+# then doxygen will show the dependencies a directory has on other directories
+# in a graphical way. The dependency relations are determined by the #include
+# relations between the files in the directories.
+
+DIRECTORY_GRAPH        = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. Possible values are svg, png, jpg, or gif.
+# If left blank png will be used. If you choose svg you need to set
+# HTML_FILE_EXTENSION to xhtml in order to make the SVG files
+# visible in IE 9+ (other browsers do not have this requirement).
+
+DOT_IMAGE_FORMAT       = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+# Note that this requires a modern browser other than Internet Explorer.
+# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
+# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
+# visible. Older versions of IE do not have SVG support.
+
+INTERACTIVE_SVG        = NO
+
+# The tag DOT_PATH can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+
+DOT_PATH               =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the
+# \dotfile command).
+
+DOTFILE_DIRS           =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the
+# \mscfile command).
+
+MSCFILE_DIRS           =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
+# nodes that will be shown in the graph. If the number of nodes in a graph
+# becomes larger than this value, doxygen will truncate the graph, which is
+# visualized by representing a node as a red box. Note that doxygen if the
+# number of direct children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
+# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+
+DOT_GRAPH_MAX_NODES    = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
+# graphs generated by dot. A depth value of 3 means that only nodes reachable
+# from the root by following a path via at most 3 edges will be shown. Nodes
+# that lay further from the root node will be omitted. Note that setting this
+# option to 1 or 2 may greatly reduce the computation time needed for large
+# code bases. Also note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+
+MAX_DOT_GRAPH_DEPTH    = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not
+# seem to support this out of the box. Warning: Depending on the platform used,
+# enabling this option may lead to badly anti-aliased labels on the edges of
+# a graph (i.e. they become hard to read).
+
+DOT_TRANSPARENT        = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10)
+# support this, this feature is disabled by default.
+
+DOT_MULTI_TARGETS      = NO
+
+# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will
+# generate a legend page explaining the meaning of the various boxes and
+# arrows in the dot generated graphs.
+
+GENERATE_LEGEND        = YES
+
+# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will
+# remove the intermediate dot files that are used to generate
+# the various graphs.
+
+DOT_CLEANUP            = YES

Examples/SoilWaterStructureInteraction/dynsws/trunk/.svn/text-base/field_data.f90.svn-base

+! ------------------------------------------------------------------------
+!>  \brief Module for Field Data
+! ------------------------------------------------------------------------
+MODULE field_data
+USE system_constants      !> Global system constants
+USE log_message_control   !> Printing log/error messages
+USE log_messages          !> Log/error message and sender codes
+USE material_data         !> Material Property Data
+
+IMPLICIT NONE
+PRIVATE
+
+
+
+! ************************************************************************
+! EXPORTS
+! ************************************************************************
+
+
+!> Exported interfaces
+PUBLIC :: fld_initTime, fld_cleanTime, &
+          fld_timeStep, fld_numTimeSteps, &
+          fld_initNode, fld_cleanNode, &
+          fld_numNode, &
+          fld_getCoord, fld_setCoord, &
+          fld_getFix, fld_setFix, &
+          fld_initDof, fld_numDof, fld_getDof, &
+          fld_getDisp, fld_setDisp, &
+          fld_getVel, fld_setVel, &
+          fld_getAcc, fld_setAcc, &
+          fld_getBodyAcc, fld_setBodyAcc, &
+          fld_getStressNode, fld_setStressNode, &
+          fld_getStrainNode, fld_setStrainNode, &
+          fld_initElem, fld_cleanElem, &
+          fld_numElem, &
+          fld_getConnect, fld_setConnect, &
+          fld_volElem, &
+          fld_getMaterial, fld_setMaterial, &
+          fld_getStressElem, fld_setStressElem, &
+          fld_getStrainElem, fld_setStrainElem
+
+
+
+! ************************************************************************
+! LOCAL CONSTANTS
+! ************************************************************************
+
+!> sender code for this module
+INTEGER, PARAMETER :: sdr = FLDDAT
+
+!> subscripts for tensor variables
+INTEGER, PARAMETER, PUBLIC :: s11=1, s22=2, s12=3, s33=4
+
+
+
+! ************************************************************************
+! DATA TYPES
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Coordinate
+!!
+!!  \param x    Set of coordinates
+! ------------------------------------------------------------------------
+TYPE coordT
+  DOUBLE PRECISION, DIMENSION(NDIM) :: x
+END TYPE coordT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Displacement
+!!
+!!  \param u    Set of displacements
+! ------------------------------------------------------------------------
+TYPE dispT
+  DOUBLE PRECISION, DIMENSION(NDIM) :: u
+END TYPE dispT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Velocity
+!!
+!!  \param v    Set of velocities
+! ------------------------------------------------------------------------
+TYPE velT
+  DOUBLE PRECISION, DIMENSION(NDIM) :: v
+END TYPE velT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Acceleration
+!!
+!!  \param a    Set of accelerations
+! ------------------------------------------------------------------------
+TYPE accT
+  DOUBLE PRECISION, DIMENSION(NDIM) :: a
+END TYPE accT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Fixity
+!!
+!!  \param fix   Set of fixities
+! ------------------------------------------------------------------------
+TYPE fixT
+  LOGICAL, DIMENSION(NDIM) :: fix
+END TYPE fixT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Degrees of freedom
+!!
+!!  \param dof   Set of degree of freedom indices
+! ------------------------------------------------------------------------
+TYPE dofT
+  INTEGER, DIMENSION(NDIM) :: dof
+END TYPE dofT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Stress
+!!
+!!  \param sig   Set of stresses
+! ------------------------------------------------------------------------
+TYPE stressT
+  DOUBLE PRECISION, DIMENSION(NTNS) :: sig
+END TYPE stressT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Strain
+!!
+!!  \param eps   Set of strains
+! ------------------------------------------------------------------------
+TYPE strainT
+  DOUBLE PRECISION, DIMENSION(NTNS) :: eps
+END TYPE strainT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Connectivity
+!!
+!!  \param nd   Sequence of node indices
+! ------------------------------------------------------------------------
+TYPE connectT
+  INTEGER, DIMENSION(NNODEL) :: nd
+END TYPE connectT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Node
+!!
+!!  \param num      Node number
+!!  \param pt       Node coordinates
+!!  \param fix      Fixities
+!!  \param dof      Degrees of freedom
+!!  \param disp     Displacement
+!!  \param vel      Velocity
+!!  \param acc      Acceleration
+!!  \param body     Body acceleration
+!!  \param stress   Nodal stress
+!!  \param strain   Nodal strain
+! ------------------------------------------------------------------------
+TYPE nodeT
+  INTEGER       :: num
+  TYPE(coordT)  :: pt
+  TYPE(fixT)    :: fix
+  TYPE(dofT)    :: dof
+  TYPE(dispT)   :: disp
+  TYPE(velT)    :: vel
+  TYPE(accT)    :: acc
+  TYPE(accT)    :: body
+  TYPE(stressT) :: stress
+  TYPE(strainT) :: strain
+END TYPE nodeT
+
+
+! ------------------------------------------------------------------------
+!>  \brief Element
+!!
+!!  \param num      Element number
+!!  \param ico      Connectivity of local nodes
+!!  \param mtl      Material number
+!!  \param stress   Element stress
+!!  \param strain   Element strain
+! ------------------------------------------------------------------------
+TYPE elementT
+  INTEGER         :: num
+  TYPE(connectT)  :: ico
+  INTEGER         :: mtl
+  TYPE(stressT)   :: stress
+  TYPE(strainT)   :: strain
+END TYPE elementT
+
+
+
+! ************************************************************************
+! STATE VARIABLES
+! ************************************************************************
+
+DOUBLE PRECISION, SAVE        :: dTime        = 0.d0    !> time step
+INTEGER,          SAVE        :: nTime        = 0       !> number of time steps
+TYPE(nodeT),      ALLOCATABLE :: nodes(:)               !> set of nodes
+TYPE(elementT),   ALLOCATABLE :: elements(:)            !> set of body elements
+INTEGER,          SAVE        :: ndof         = 0       !> total number of degrees of freedom
+
+
+
+! ************************************************************************
+! INTERFACES
+! ************************************************************************
+
+
+!> \brief Interface to initializer for time-stepping information
+INTERFACE fld_initTime
+  MODULE PROCEDURE fld_init_time_
+  MODULE PROCEDURE fld_init_time_exc_
+END INTERFACE fld_initTime
+
+!> \brief Interface to destructor for time-stepping information
+INTERFACE fld_cleanTime
+  MODULE PROCEDURE fld_clean_time_
+END INTERFACE fld_cleanTime
+
+!> \brief Interface to getter for time step
+INTERFACE fld_timeStep
+  MODULE PROCEDURE fld_time_step_
+END INTERFACE fld_timeStep
+
+!> \brief Interface to getter for number of time steps
+INTERFACE fld_numTimeSteps
+  MODULE PROCEDURE fld_num_time_steps_
+END INTERFACE fld_numTimeSteps
+
+!> \brief Interface to initializer for node information
+INTERFACE fld_initNode
+  MODULE PROCEDURE fld_init_node_
+  MODULE PROCEDURE fld_init_node_exc_
+END INTERFACE fld_initNode
+
+!> \brief Interface to destructor for node information
+INTERFACE fld_cleanNode
+  MODULE PROCEDURE fld_clean_node_
+END INTERFACE fld_cleanNode
+
+!> \brief Interface to getter for number of nodes
+INTERFACE fld_numNode
+  MODULE PROCEDURE fld_num_node_
+END INTERFACE fld_numNode
+
+!> \brief Interface to getter for node coordinates
+INTERFACE fld_getCoord
+  MODULE PROCEDURE fld_get_coord_
+  MODULE PROCEDURE fld_get_coord_exc_
+END INTERFACE fld_getCoord
+
+!> \brief Interface to setter for node coordinates
+INTERFACE fld_setCoord
+  MODULE PROCEDURE fld_set_coord_
+  MODULE PROCEDURE fld_set_coord_exc_
+END INTERFACE fld_setCoord
+
+!> \brief Interface to getter for node fixity
+INTERFACE fld_getFix
+  MODULE PROCEDURE fld_get_fix_
+  MODULE PROCEDURE fld_get_fix_exc_
+END INTERFACE fld_getFix
+
+!> \brief Interface to setter for node fixity
+INTERFACE fld_setFix
+  MODULE PROCEDURE fld_set_fix_
+  MODULE PROCEDURE fld_set_fix_exc_
+END INTERFACE fld_setFix
+
+!> \brief Interface to initializer for degrees of freedom
+INTERFACE fld_initDof
+  MODULE PROCEDURE fld_init_dof_exc_
+END INTERFACE fld_initDof
+
+!> \brief Interface to getter for number of degrees of freedom
+INTERFACE fld_numDof
+  MODULE PROCEDURE fld_num_dof_
+END INTERFACE fld_numDof
+
+!> \brief Interface to getter for degree of freedom
+INTERFACE fld_getDof
+  MODULE PROCEDURE fld_get_dof_
+  MODULE PROCEDURE fld_get_dof_exc_
+END INTERFACE fld_getDof
+
+!> \brief Interface to getter for node displacement
+INTERFACE fld_getDisp
+  MODULE PROCEDURE fld_get_disp_
+  MODULE PROCEDURE fld_get_disp_exc_
+END INTERFACE fld_getDisp
+
+!> \brief Interface to setter for node displacement
+INTERFACE fld_setDisp
+  MODULE PROCEDURE fld_set_disp_
+  MODULE PROCEDURE fld_set_disp_exc_
+END INTERFACE fld_setDisp
+
+!> \brief Interface to getter for node velocity
+INTERFACE fld_getVel
+  MODULE PROCEDURE fld_get_vel_
+  MODULE PROCEDURE fld_get_vel_exc_
+END INTERFACE fld_getVel
+
+!> \brief Interface to setter for node velocity
+INTERFACE fld_setVel
+  MODULE PROCEDURE fld_set_vel_
+  MODULE PROCEDURE fld_set_vel_exc_
+END INTERFACE fld_setVel
+
+!> \brief Interface to getter for node acceleration
+INTERFACE fld_getAcc
+  MODULE PROCEDURE fld_get_acc_
+  MODULE PROCEDURE fld_get_acc_exc_
+END INTERFACE fld_getAcc
+
+!> \brief Interface to setter for node acceleration
+INTERFACE fld_setAcc
+  MODULE PROCEDURE fld_set_acc_
+  MODULE PROCEDURE fld_set_acc_exc_
+END INTERFACE fld_setAcc
+
+!> \brief Interface to getter for body acceleration at node
+INTERFACE fld_getBodyAcc
+  MODULE PROCEDURE fld_get_body_acc_
+  MODULE PROCEDURE fld_get_body_acc_exc_
+END INTERFACE fld_getBodyAcc
+
+!> \brief Interface to setter for body acceleration at node
+INTERFACE fld_setBodyAcc
+  MODULE PROCEDURE fld_set_body_acc_
+  MODULE PROCEDURE fld_set_body_acc_exc_
+END INTERFACE fld_setBodyAcc
+
+!> \brief Interface to getter for node stress
+INTERFACE fld_getStressNode
+  MODULE PROCEDURE fld_get_stress_node_
+  MODULE PROCEDURE fld_get_stress_node_exc_
+END INTERFACE fld_getStressNode
+
+!> \brief Interface to setter for node stress
+INTERFACE fld_setStressNode
+  MODULE PROCEDURE fld_set_stress_node_
+  MODULE PROCEDURE fld_set_stress_node_exc_
+END INTERFACE fld_setStressNode
+
+!> \brief Interface to getter for node strain
+INTERFACE fld_getStrainNode
+  MODULE PROCEDURE fld_get_strain_node_
+  MODULE PROCEDURE fld_get_strain_node_exc_
+END INTERFACE fld_getStrainNode
+
+!> \brief Interface to setter for node strain
+INTERFACE fld_setStrainNode
+  MODULE PROCEDURE fld_set_strain_node_
+  MODULE PROCEDURE fld_set_strain_node_exc_
+END INTERFACE fld_setStrainNode
+
+!> \brief Interface to initializer for elements
+INTERFACE fld_initElem
+  MODULE PROCEDURE fld_init_elem_
+  MODULE PROCEDURE fld_init_elem_exc_
+END INTERFACE fld_initElem
+
+!> \brief Interface to destructor for element information
+INTERFACE fld_cleanElem
+  MODULE PROCEDURE fld_clean_elem_
+END INTERFACE fld_cleanElem
+
+!> \brief Interface to getter for number of elements
+INTERFACE fld_numElem
+  MODULE PROCEDURE fld_num_elem_
+END INTERFACE fld_numElem
+
+!> \brief Interface to getter for element connectivity
+INTERFACE fld_getConnect
+  MODULE PROCEDURE fld_get_connect_
+  MODULE PROCEDURE fld_get_connect_exc_
+END INTERFACE fld_getConnect
+
+!> \brief Interface to setter for element connectivity
+INTERFACE fld_setConnect
+  MODULE PROCEDURE fld_set_connect_
+  MODULE PROCEDURE fld_set_connect_exc_
+END INTERFACE fld_setConnect
+
+!> \brief Interface to getter for volume of element
+INTERFACE fld_volElem
+  MODULE PROCEDURE fld_vol_elem_
+  MODULE PROCEDURE fld_vol_elem_exc_
+END INTERFACE fld_volElem
+
+!> \brief Interface to getter for element material
+INTERFACE fld_getMaterial
+  MODULE PROCEDURE fld_get_material_
+  MODULE PROCEDURE fld_get_material_exc_
+END INTERFACE fld_getMaterial
+
+!> \brief Interface to setter for element material
+INTERFACE fld_setMaterial
+  MODULE PROCEDURE fld_set_material_
+  MODULE PROCEDURE fld_set_material_exc_
+END INTERFACE fld_setMaterial
+
+!> \brief Interface to getter for element stress
+INTERFACE fld_getStressElem
+  MODULE PROCEDURE fld_get_stress_elem_
+  MODULE PROCEDURE fld_get_stress_elem_exc_
+END INTERFACE fld_getStressElem
+
+!> \brief Interface to setter for element stress
+INTERFACE fld_setStressElem
+  MODULE PROCEDURE fld_set_stress_elem_
+  MODULE PROCEDURE fld_set_stress_elem_exc_
+END INTERFACE fld_setStressElem
+
+!> \brief Interface to getter for element strain
+INTERFACE fld_getStrainElem
+  MODULE PROCEDURE fld_get_strain_elem_
+  MODULE PROCEDURE fld_get_strain_elem_exc_
+END INTERFACE fld_getStrainElem
+
+!> \brief Interface to setter for element strain
+INTERFACE fld_setStrainElem
+  MODULE PROCEDURE fld_set_strain_elem_
+  MODULE PROCEDURE fld_set_strain_elem_exc_
+END INTERFACE fld_setStrainElem
+
+
+
+CONTAINS
+
+
+
+! ************************************************************************
+! ACCESS PROGRAMS
+! ************************************************************************
+
+
+! ------------------------------------------------------------------------
+!>  \brief Initializer for time-stepping data (non-exception checking)
+!!
+!!  \param  dt  Time step
+!!  \param  n   Number of time steps
+!!
+!!  This routine sets the module state parameters for time step and total
+!!  number of time steps.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_init_time_ (dt,n)
+  DOUBLE PRECISION, INTENT(IN) :: dt
+  INTEGER, INTENT(IN) :: n
+
+  dTime = dt
+  nTime = n
+
+END SUBROUTINE fld_init_time_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Initializer for time-stepping data (exception checking)
+!!
+!!  \param  dt  Time step
+!!  \param  n   Number of time steps
+!!  \param  exc Error code
+!!
+!!  \exception  EXCEED  Size of time step or number of time steps exceed definined min/max values
+!!
+!!  This routine sets the module state parameters for time step and total
+!!  number of time steps.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_init_time_exc_ (dt,n, exc)
+  DOUBLE PRECISION, INTENT(IN) :: dt
+  INTEGER, INTENT(IN) :: n
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that time step and number of time steps are valid
+  IF (  dt.LT.DTIME_MIN .OR. dt.GT.DTIME_MAX  &
+        .OR. n.LT.1 .OR. n.GT.MAX_TIMESTEPS ) THEN
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    CALL fld_cleanTime()
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_initTime(dt,n)
+
+END SUBROUTINE fld_init_time_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Destructor for time-stepping data
+!!
+!!  This routine resets the module state parameters for time step and
+!!  total number of time steps to 0.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_clean_time_ ()
+
+  dTime = 0.d0
+  nTime = 0
+
+END SUBROUTINE fld_clean_time_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for size of time step
+!!
+!!  \return dt  Time step
+! ------------------------------------------------------------------------
+FUNCTION fld_time_step_ () RESULT(dt)
+  DOUBLE PRECISION :: dt
+
+  dt = dTime
+
+END FUNCTION fld_time_step_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for number of time steps
+!!
+!!  \return n   Number of time steps
+! ------------------------------------------------------------------------
+FUNCTION fld_num_time_steps_ () RESULT(n)
+  DOUBLE PRECISION :: n
+
+  n = nTime
+
+END FUNCTION fld_num_time_steps_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for node data (non-exception checking)
+!!
+!!  \param  nnod  Number of nodes
+!!
+!!  This routine allocates memory and initializes the state variable that
+!!  contains the set of nodes for the problem.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_init_node_ (nnod)
+  INTEGER, INTENT(IN) :: nnod
+  INTEGER :: i, j     !> loop variables
+
+  !> only reallocate if new dimensions do not match existing dimensions
+  IF (fld_numNode().NE.nnod) THEN
+
+    !> ensure state variable is clear
+    CALL fld_cleanNode()
+
+    !> allocate memory for node data state variable
+    ALLOCATE(nodes(nnod))
+
+  END IF
+
+  !> initialize state variable
+
+  ndof = 0
+
+  DO i = 1,nnod
+
+    !> node number
+    nodes(i)%num   = i
+
+    !> vector variables
+    DO j = 1,NDIM
+      nodes(i)%pt   %x(j)   = 0.d0
+      nodes(i)%fix  %fix(j) = .FALSE.
+      nodes(i)%dof  %dof(j) = 0
+      nodes(i)%disp %u(j)   = 0.d0
+      nodes(i)%vel  %v(j)   = 0.d0
+      nodes(i)%acc  %a(j)   = 0.d0
+      nodes(i)%body %a(j)   = 0.d0
+    END DO
+
+    !> tensor variables
+    DO j = 1,NTNS
+      nodes(i)%stress%sig(j) = 0.d0
+      nodes(i)%strain%eps(j) = 0.d0
+    END DO
+
+  END DO
+
+END SUBROUTINE fld_init_node_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for node data (exception checking)
+!!
+!!  \param  nnod  Number of nodes
+!!  \param  exc   Error code
+!!
+!!  \exception  ALLOC Failed to allocate memory for node data
+!!  \exception  SZE   Specified number of nodes is invalid
+!!
+!!  This routine allocates memory and initializes the state variable that
+!!  contains the set of nodes for the problem.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_init_node_exc_ (nnod, exc)
+  INTEGER, INTENT(IN) :: nnod
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: e        !> status code for memory allocation
+  INTEGER :: i, j     !> loop variables
+
+  !> make sure number of nodes is valid
+  IF (nnod.LT.1 .OR. nnod.GT.MAX_NODES) THEN
+    exc=SZE
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> only reallocate if new dimensions do not match existing dimensions
+  IF (fld_numNode().NE.nnod) THEN
+
+    !> ensure state variable is clear
+    CALL fld_cleanNode()
+
+    !> allocate memory for node data state variable
+    ALLOCATE(nodes(nnod), STAT=e)
+
+    !> make sure memory allocation was successful
+    IF (e.NE.0) THEN
+      exc=ALLOC
+      CALL log_printLogMsg(exc,sdr)
+      RETURN
+    ELSE
+      exc=OK
+    END IF
+
+  END IF
+
+  !> initialize state variable
+
+  ndof = 0
+
+  DO i = 1,nnod
+
+    !> node number
+    nodes(i)%num   = i
+
+    !> vector variables
+    DO j = 1,NDIM
+      nodes(i)%pt   %x(j)   = 0.d0
+      nodes(i)%fix  %fix(j) = .FALSE.
+      nodes(i)%dof  %dof(j) = 0
+      nodes(i)%disp %u(j)   = 0.d0
+      nodes(i)%vel  %v(j)   = 0.d0
+      nodes(i)%acc  %a(j)   = 0.d0
+      nodes(i)%body %a(j)   = 0.d0
+    END DO
+
+    !> tensor variables
+    DO j = 1,NTNS
+      nodes(i)%stress%sig(j) = 0.d0
+      nodes(i)%strain%eps(j) = 0.d0
+    END DO
+
+  END DO
+
+END SUBROUTINE fld_init_node_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Destructor for node data
+!!
+!!  This routine clears the memory allocated to the state variable that
+!!  contains the set of node data for the problem. It also resets the
+!!  degree of freedom counter (since there cannot be degrees of freedom
+!!  without nodes).
+! ------------------------------------------------------------------------
+SUBROUTINE fld_clean_node_ ()
+
+  IF (ALLOCATED(nodes)) DEALLOCATE(nodes)
+
+  ndof = 0
+
+END SUBROUTINE fld_clean_node_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for number of nodes
+!!
+!!  \return nnod  Number of nodes
+!!
+!!  This routine determines the number of data entries that have been
+!!  allocated for node data. It does not check that the node data
+!!  has been populated (i.e. changed from initial zero values).
+! ------------------------------------------------------------------------
+FUNCTION fld_num_node_ () RESULT(nnod)
+  INTEGER :: nnod
+
+  !> if data is initialized, return number of nodes
+  IF (ALLOCATED(nodes)) THEN
+    nnod = SIZE(nodes)
+  ELSE
+    nnod = 0   !> if not initialized, there are no nodes
+  END IF
+
+END FUNCTION fld_num_node_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node coordinates (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!
+!!  \return x     Coordinate value
+!!
+!!  This routine determines the value of the coordinate for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_coord_ (i,j) RESULT(x)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: x
+
+  x = nodes(i)%pt%x(j)
+
+END FUNCTION fld_get_coord_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node coordinates (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  exc   Error code
+!!
+!!  \return x     Coordinate value
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    coordinate index is not in [1..NDIM]
+!!
+!!  This routine determines the value of the coordinate for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_coord_exc_ (i,j, exc) RESULT(x)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: x
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    x = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  x = fld_getCoord(i,j)
+
+END FUNCTION fld_get_coord_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node coordinates (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  x     Coordinate value
+!!
+!!  This routine sets the value of the coordinate for node number i in
+!!  coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_coord_ (i,j, x)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: x
+
+  nodes(i)%pt%x(j) = x
+
+END SUBROUTINE fld_set_coord_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node coordinates (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  x     Coordinate value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the coordinate exceeds prescribed
+!!                      limits
+!!  \exception  POSIT   The node number is not in [1..fld_numNode()] or
+!!                      the coordinate index is not in [1..NDIM]
+!!
+!!  This routine sets the value of the coordinate for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_coord_exc_ (i,j, x, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: x
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (x.LT.COORD_MIN .OR. x.GT.COORD_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setCoord(i,j, x)
+
+END SUBROUTINE fld_set_coord_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for fixities (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!
+!!  \return fix   Fixity value
+!!
+!!  This routine determines the value of the fixity for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_fix_ (i,j) RESULT(fix)
+  INTEGER, INTENT(IN) :: i,j
+  LOGICAL :: fix
+
+  fix = nodes(i)%fix%fix(j)
+
+END FUNCTION fld_get_fix_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for fixities (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  exc   Error code
+!!
+!!  \return fix   Fixity value
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    coordinate index is not in [1..NDIM]
+!!
+!!  This routine determines the value of the fixity for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_fix_exc_ (i,j, exc) RESULT(fix)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  LOGICAL :: fix
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    fix = .FALSE.
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  fix = fld_getFix(i,j)
+
+END FUNCTION fld_get_fix_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for fixities (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  fix   Fixity value
+!!
+!!  This routine sets the value of the fixity for node number i in
+!!  coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_fix_ (i,j, fix)
+  INTEGER, INTENT(IN) :: i,j
+  LOGICAL, INTENT(IN) :: fix
+
+  nodes(i)%fix%fix(j) = fix
+
+END SUBROUTINE fld_set_fix_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for fixities (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  fix   Fixity value
+!!  \param  exc   Error code
+!!
+!!  \exception  POSIT   The node number is not in [1..fld_numNode()] or
+!!                      the coordinate index is not in [1..NDIM]
+!!
+!!  This routine sets the value of the coordinate for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_fix_exc_ (i,j, fix, exc)
+  INTEGER, INTENT(IN) :: i,j
+  LOGICAL, INTENT(IN) :: fix
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setFix(i,j, fix)
+
+END SUBROUTINE fld_set_fix_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Initializer for nodal degrees of freedom
+!!
+!!  \param  exc   Error code
+!!
+!!  \exception  SZE   The number of degrees of freedom exceeds the maximum
+!!                    defined in the System Constants module
+! ------------------------------------------------------------------------
+SUBROUTINE fld_init_dof_exc_ (exc)
+  INTEGER, INTENT(OUT), OPTIONAL :: exc
+  INTEGER :: i,j    !> loop variables
+
+  !> initialize degree of freedom counter
+  ndof = 0
+
+  !> loop through nodes, setting dof number for unfixed dofs
+  DO i = 1,fld_numNode()
+    DO j = 1,NDIM
+
+      !> if dof is fixed, set dof number to 0
+      IF ( fld_getFix(i,j) ) THEN
+
+        nodes(i)%dof%dof(j) = 0
+
+      !> otherwise, increment dof counter and set dof number
+      ELSE
+
+        ndof = ndof+1
+
+        !> make sure number of dofs does not exceed limit
+        IF (PRESENT(exc) .AND. ndof.GT.MAX_DOFS) THEN
+          exc=SZE
+          CALL log_printLogMsg(exc,sdr)
+          ndof = 0
+          RETURN
+        END IF
+
+        nodes(i)%dof%dof(j) = ndof
+
+      END IF
+
+    END DO
+  END DO
+
+  !> if the loop completed without returning, no exception was raised
+  IF (PRESENT(exc)) exc=OK
+
+END SUBROUTINE fld_init_dof_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for number of degrees of freedom
+!!
+!!  \return n  Number of degrees of freedom
+!!
+!!  This routine determines the number of degrees of freedom for the
+!!  system.
+! ------------------------------------------------------------------------
+FUNCTION fld_num_dof_ () RESULT(n)
+  INTEGER :: n
+
+  n = ndof
+
+END FUNCTION fld_num_dof_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for degree of freedom (non-exception checking)
+!!
+!!  \param  i   Node number
+!!  \param  j   Coordinate index
+!!
+!!  \return dof Degree of freedom number
+!!
+!!  This routine determines the index number associated with degree of
+!!  freedom j for node i. Note that a return value of 0 indicates that the
+!!  degree of freedom is fixed (and will not be necessary for the solution
+!!  of the system).
+! ------------------------------------------------------------------------
+FUNCTION fld_get_dof_ (i,j) RESULT(dof)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER :: dof
+
+  dof = nodes(i)%dof%dof(j)
+
+END FUNCTION fld_get_dof_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for degree of freedom (exception checking)
+!!
+!!  \param  i   Node number
+!!  \param  j   Coordinate index
+!!  \param  exc Error code
+!!
+!!  \return dof Degree of freedom number
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    coordinate index is not in [1..NDIM]
+!!
+!!  This routine determines the index number associated with degree of
+!!  freedom j for node i. Note that a return value of 0 indicates that the
+!!  degree of freedom is fixed (and will not be necessary for the solution
+!!  of the system).
+! ------------------------------------------------------------------------
+FUNCTION fld_get_dof_exc_ (i,j, exc) RESULT(dof)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: dof
+
+  !> check that the given indices are valid
+  IF (  i.LT.1 .OR. i.GT.fld_numNode()  &
+        .OR. j.LT.1 .OR. j.GT.NDIM )    THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    dof=0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> make sure dofs have been initialized
+  IF (ndof.EQ.0) THEN
+    dof=0
+  ELSE
+    !> call non-exception version
+    dof = fld_getDof(i,j)
+  END IF
+
+END FUNCTION fld_get_dof_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node displacements (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!
+!!  \return u     Displacement value
+!!
+!!  This routine determines the value of the displacement for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_disp_ (i,j) RESULT(u)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: u
+
+  u = nodes(i)%disp%u(j)
+
+END FUNCTION fld_get_disp_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node displacements (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  exc   Error code
+!!
+!!  \return u     Displacement value
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    coordinate index is not in [1..NDIM]
+!!
+!!  This routine determines the value of the displacement for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_disp_exc_ (i,j, exc) RESULT(u)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: u
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    u = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  u = fld_getDisp(i,j)
+
+END FUNCTION fld_get_disp_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node displacements (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  u     Displacement value
+!!
+!!  This routine sets the value of the displacement for node number i in
+!!  coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_disp_ (i,j, u)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: u
+
+  nodes(i)%disp%u(j) = u
+
+END SUBROUTINE fld_set_disp_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node displacements (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  u     Displacement value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the displacement exceeds prescribed
+!!                      limits
+!!  \exception  POSIT   The node number is not in [1..fld_numNode()] or
+!!                      the coordinate index is not in [1..NDIM]
+!!
+!!  This routine sets the value of the displacement for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_disp_exc_ (i,j, u, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: u
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (u.LT.DISP_MIN .OR. u.GT.DISP_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setDisp(i,j, u)
+
+END SUBROUTINE fld_set_disp_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node velocities (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!
+!!  \return v     Velocity value
+!!
+!!  This routine determines the value of the velocity for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_vel_ (i,j) RESULT(v)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: v
+
+  v = nodes(i)%vel%v(j)
+
+END FUNCTION fld_get_vel_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node velocities (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  exc   Error code
+!!
+!!  \return v     Velocity value
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    coordinate index is not in [1..NDIM]
+!!
+!!  This routine determines the value of the velocity for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_vel_exc_ (i,j, exc) RESULT(v)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: v
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    v = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  v = fld_getVel(i,j)
+
+END FUNCTION fld_get_vel_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node velocities (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  v     Velocity value
+!!
+!!  This routine sets the value of the velocity for node number i in
+!!  coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_vel_ (i,j, v)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: v
+
+  nodes(i)%vel%v(j) = v
+
+END SUBROUTINE fld_set_vel_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node velocities (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  v     Velocity value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the velocity exceeds prescribed
+!!                      limits
+!!  \exception  POSIT   The node number is not in [1..fld_numNode()] or
+!!                      the coordinate index is not in [1..NDIM]
+!!
+!!  This routine sets the value of the velocity for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_vel_exc_ (i,j, v, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: v
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (v.LT.VEL_MIN .OR. v.GT.VEL_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setVel(i,j, v)
+
+END SUBROUTINE fld_set_vel_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node accelerations (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!
+!!  \return a     Acceleration value
+!!
+!!  This routine determines the value of the acceleration for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_acc_ (i,j) RESULT(a)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: a
+
+  a = nodes(i)%acc%a(j)
+
+END FUNCTION fld_get_acc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node accelerations (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  exc   Error code
+!!
+!!  \return a     Acceleration value
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    coordinate index is not in [1..NDIM]
+!!
+!!  This routine determines the value of the acceleration for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_acc_exc_ (i,j, exc) RESULT(a)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: a
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    a = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  a = fld_getAcc(i,j)
+
+END FUNCTION fld_get_acc_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node accelerations (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  a     Acceleration value
+!!
+!!  This routine sets the value of the acceleration for node number i in
+!!  coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_acc_ (i,j, a)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: a
+
+  nodes(i)%acc%a(j) = a
+
+END SUBROUTINE fld_set_acc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node accelerations (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  a     Acceleration value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the acceleration exceeds prescribed
+!!                      limits
+!!  \exception  POSIT   The node number is not in [1..fld_numNode()] or
+!!                      the coordinate index is not in [1..NDIM]
+!!
+!!  This routine sets the value of the acceleration for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_acc_exc_ (i,j, a, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: a
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (a.LT.ACC_MIN .OR. a.GT.ACC_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setAcc(i,j, a)
+
+END SUBROUTINE fld_set_acc_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node body accelerations (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!
+!!  \return a     Body acceleration value
+!!
+!!  This routine determines the value of the body acceleration for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_body_acc_ (i,j) RESULT(a)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: a
+
+  a = nodes(i)%body%a(j)
+
+END FUNCTION fld_get_body_acc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node body accelerations (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  exc   Error code
+!!
+!!  \return a     Body acceleration value
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    coordinate index is not in [1..NDIM]
+!!
+!!  This routine determines the value of the body acceleration for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_body_acc_exc_ (i,j, exc) RESULT(a)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: a
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    a = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  a = fld_getBodyAcc(i,j)
+
+END FUNCTION fld_get_body_acc_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node body accelerations (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  a     Body acceleration value
+!!
+!!  This routine sets the value of the body acceleration for node number i
+!!  in coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_body_acc_ (i,j, a)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: a
+
+  nodes(i)%body%a(j) = a
+
+END SUBROUTINE fld_set_body_acc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node body accelerations (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Coordinate index
+!!  \param  a     Body acceleration value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the body acceleration exceeds
+!!                      prescribed limits
+!!  \exception  POSIT   The node number is not in [1..fld_numNode()] or
+!!                      the coordinate index is not in [1..NDIM]
+!!
+!!  This routine sets the value of the body acceleration for node
+!!  number i in coordinate direction j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_body_acc_exc_ (i,j, a, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: a
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the coordinate index is within [1..NDIM]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NDIM ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (a.LT.ACC_MIN .OR. a.GT.ACC_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setBodyAcc(i,j, a)
+
+END SUBROUTINE fld_set_body_acc_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node stresses (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Tensor index
+!!
+!!  \return s     Stress value
+!!
+!!  This routine determines the value of the stress for node
+!!  number i for tensor index j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_stress_node_ (i,j) RESULT(s)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: s
+
+  s = nodes(i)%stress%sig(j)
+
+END FUNCTION fld_get_stress_node_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node stresses (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Tensor index
+!!  \param  exc   Error code
+!!
+!!  \return s     Stress value
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    tensor index is not in [1..NTNS]
+!!
+!!  This routine determines the value of the stress for node
+!!  number i for tensor index j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_stress_node_exc_ (i,j, exc) RESULT(s)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: s
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the tensor index is within [1..NTNS]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NTNS ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    s = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  s = fld_getStressNode(i,j)
+
+END FUNCTION fld_get_stress_node_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node stresses (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Tensor index
+!!  \param  s     Stress value
+!!
+!!  This routine sets the value of the stress for node number i
+!!  for tensor index j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_stress_node_ (i,j, s)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: s
+
+  nodes(i)%stress%sig(j) = s
+
+END SUBROUTINE fld_set_stress_node_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node stresses (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Tensor index
+!!  \param  s     Stress value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the stress exceeds prescribed limits
+!!  \exception  POSIT   The node number is not in [1..fld_numNode()] or
+!!                      the tensor index is not in [1..NTNS]
+!!
+!!  This routine sets the value of the stress for node number i for
+!!  tensor index j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_stress_node_exc_ (i,j, s, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: s
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the tensor index is within [1..NTNS]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NTNS ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (s.LT.SIG_MIN .OR. s.GT.SIG_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setStressNode(i,j, s)
+
+END SUBROUTINE fld_set_stress_node_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node strains (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Tensor index
+!!
+!!  \return s     Strain value
+!!
+!!  This routine determines the value of the strain for node
+!!  number i for tensor index j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_strain_node_ (i,j) RESULT(s)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: s
+
+  s = nodes(i)%strain%eps(j)
+
+END FUNCTION fld_get_strain_node_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for node strains (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Tensor index
+!!  \param  exc   Error code
+!!
+!!  \return s     Strain value
+!!
+!!  \exception  POSIT The node number is not in [1..fld_numNode()] or the
+!!                    tensor index is not in [1..NTNS]
+!!
+!!  This routine determines the value of the strain for node
+!!  number i for tensor index j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_strain_node_exc_ (i,j, exc) RESULT(s)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: s
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the tensor index is within [1..NTNS]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NTNS ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    s = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  s = fld_getStrainNode(i,j)
+
+END FUNCTION fld_get_strain_node_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node strains (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Tensor index
+!!  \param  s     Strain value
+!!
+!!  This routine sets the value of the strain for node number i
+!!  for tensor index j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_strain_node_ (i,j, s)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: s
+
+  nodes(i)%strain%eps(j) = s
+
+END SUBROUTINE fld_set_strain_node_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for node strains (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Tensor index
+!!  \param  s     Strain value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the strain exceeds prescribed limits
+!!  \exception  POSIT   The node number is not in [1..fld_numNode()] or
+!!                      the tensor index is not in [1..NTNS]
+!!
+!!  This routine sets the value of the strain for node number i for
+!!  tensor index j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_strain_node_exc_ (i,j, s, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: s
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the node number is within the bounds of the nodes list
+  !!  and that the tensor index is within [1..NTNS]
+  IF ( i.LT.1 .OR. i.GT.fld_numNode() &
+        .OR. j.LT.1 .OR. j.GT.NTNS ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (s.LT.STR_MIN .OR. s.GT.STR_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setStrainNode(i,j, s)
+
+END SUBROUTINE fld_set_strain_node_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for element data (non-exception checking)
+!!
+!!  \param  nel  Number of elements
+!!
+!!  This routine allocates memory and initializes the state variable that
+!!  contains the set of elements for the problem.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_init_elem_ (nel)
+  INTEGER, INTENT(IN) :: nel
+  INTEGER :: i, j     !> loop variables
+
+  !> only reallocate if new dimensions do not match existing dimensions
+  IF (fld_numElem().NE.nel) THEN
+
+    !> ensure state variable is clear
+    CALL fld_cleanElem()
+
+    !> allocate memory for element data state variable
+    ALLOCATE(elements(nel))
+
+  END IF
+
+  !> initialize state variable
+  DO i = 1,nel
+
+    !> element number
+    elements(i)%num   = i
+
+    !> material number
+    elements(i)%mtl = 0
+
+    !> connectivity
+    DO j = 1,NNODEL
+      elements(i)%ico%nd(j)   = 0
+    END DO
+
+    !> tensor variables
+    DO j = 1,NTNS
+      elements(i)%stress%sig(j) = 0.d0
+      elements(i)%strain%eps(j) = 0.d0
+    END DO
+
+  END DO
+
+END SUBROUTINE fld_init_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Constructor for element data (exception checking)
+!!
+!!  \param  nel   Number of elements
+!!  \param  exc   Error code
+!!
+!!  \exception  ALLOC Failed to allocate memory for element data
+!!  \exception  SZE   Specified number of elements is invalid
+!!
+!!  This routine allocates memory and initializes the state variable that
+!!  contains the set of elements for the problem.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_init_elem_exc_ (nel, exc)
+  INTEGER, INTENT(IN) :: nel
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: e        !> status code for memory allocation
+  INTEGER :: i, j     !> loop variables
+
+  !> make sure number of elements is valid
+  IF (nel.LT.1 .OR. nel.GT.MAX_ELEMENTS) THEN
+    exc=SZE
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> only reallocate if new dimensions do not match existing dimensions
+  IF (fld_numElem().NE.nel) THEN
+
+    !> ensure state variable is clear
+    CALL fld_cleanElem()
+
+    !> allocate memory for element data state variable
+    ALLOCATE(elements(nel), STAT=e)
+
+    !> make sure memory allocation was successful
+    IF (e.NE.0) THEN
+      exc=ALLOC
+      CALL log_printLogMsg(exc,sdr)
+      RETURN
+    ELSE
+      exc=OK
+    END IF
+
+  END IF
+
+  !> initialize state variable
+  DO i = 1,nel
+
+    !> element number
+    elements(i)%num   = i
+
+    !> material number
+    elements(i)%mtl = 0
+
+    !> connectivity
+    DO j = 1,NNODEL
+      elements(i)%ico%nd(j)   = 0
+    END DO
+
+    !> tensor variables
+    DO j = 1,NTNS
+      elements(i)%stress%sig(j) = 0.d0
+      elements(i)%strain%eps(j) = 0.d0
+    END DO
+
+  END DO
+
+END SUBROUTINE fld_init_elem_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Destructor for element data
+!!
+!!  This routine clears the memory allocated to the state variable that
+!!  contains the set of element data for the problem.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_clean_elem_ ()
+
+  IF (ALLOCATED(elements)) DEALLOCATE(elements)
+
+END SUBROUTINE fld_clean_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for number of elements
+!!
+!!  \return nel  Number of elements
+!!
+!!  This routine determines the number of data entries that have been
+!!  allocated for element data. It does not check that the element data
+!!  has been populated (i.e. changed from initial zero values).
+! ------------------------------------------------------------------------
+FUNCTION fld_num_elem_ () RESULT(nel)
+  INTEGER :: nel
+
+  !> if data is initialized, return number of elements
+  IF (ALLOCATED(elements)) THEN
+    nel = SIZE(elements)
+  ELSE
+    nel = 0   !> if not initialized, there are no elements
+  END IF
+
+END FUNCTION fld_num_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for connectivity (non-exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Local node index
+!!
+!!  \return n     Global node number
+!!
+!!  This routine determines the global node number associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_connect_ (i,j) RESULT(n)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER :: n
+
+  n = elements(i)%ico%nd(j)
+
+END FUNCTION fld_get_connect_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for connectivity (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  exc   Error code
+!!
+!!  \return n     Global node number
+!!
+!!  \exception  POSIT The element number is not in [1..fld_numElem()] or
+!!                    the local node index is not in [1..NNODEL]
+!!
+!!  This routine determines the global node number associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_connect_exc_ (i,j, exc) RESULT(n)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: n
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the local node index is within [1..NNODEL]
+  IF ( i.LT.1 .OR. i.GT.fld_numElem() &
+        .OR. j.LT.1 .OR. j.GT.NNODEL ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    n = 0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  n = fld_getConnect(i,j)
+
+END FUNCTION fld_get_connect_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for connectivity (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  n     Global node number
+!!
+!!  This routine sets the global node number associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_connect_ (i,j, n)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(IN) :: n
+
+  elements(i)%ico%nd(j) = n
+
+END SUBROUTINE fld_set_connect_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for connectivity (exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  j     Local node index
+!!  \param  n     Global node number
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the node number exceeds the number of
+!!                      nodes
+!!  \exception  POSIT   The element number is not in [1..fld_numElem()] or
+!!                      the local node index is not in [1..NNODEL]
+!!
+!!  This routine sets the global node number associated with local
+!!  node j for element i.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_connect_exc_ (i,j, n, exc)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(IN) :: n
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the local node index is within [1..NNODEL]
+  IF ( i.LT.1 .OR. i.GT.fld_numElem() &
+        .OR. j.LT.1 .OR. j.GT.NNODEL ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (n.LT.1 .OR. n.GT.fld_numNode()) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setConnect(i,j, n)
+
+END SUBROUTINE fld_set_connect_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Compute the volume of an element (non-exception checking)
+!!
+!!  \param  i     Element number
+!!
+!!  \return vol   Volume of element
+!!
+!!  This routine computes the volume of a body element. Note that for a
+!!  2-D plane strain element this is equivalent to the area of the element
+!!  (considering a unit thickness). This is computed as the following
+!!  determinant:
+!!
+!!    V   =  0.5 *  | x1  y1  1 |
+!!                  | x2  y2  1 |
+!!                  | x3  y3  1 |
+!!
+!!  where xj and yj are the (x,y) coordinates of node j of element i.
+! ------------------------------------------------------------------------
+FUNCTION fld_vol_elem_ (i) RESULT(vol)
+  INTEGER, INTENT(IN) :: i
+  DOUBLE PRECISION :: vol
+  DOUBLE PRECISION, DIMENSION(NNODEL,NDIM) :: x  !> element coords
+  INTEGER :: j,k    !> loop variable
+
+  !> get element coords
+  DO k = 1,NDIM
+    DO j = 1,NNODEL
+      x(j,k) = fld_getCoord(elements(i)%ico%nd(j), k)
+    END DO
+  END DO
+
+  !> compute volume
+  vol = ( x(1,1)*x(2,2) - x(2,1)*x(1,2) )   &
+        - ( x(1,1)*x(3,2) - x(3,1)*x(1,2) ) &
+        + ( x(2,1)*x(3,2) - x(3,1)*x(2,2) )
+
+  vol = 0.5d0 * vol
+
+END FUNCTION fld_vol_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Compute the volume of an element (exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  exc   Error code
+!!
+!!  \return vol   Volume of element
+!!
+!!  \exception  POSIT   The specified element number is not within the
+!!                      range [1..fld_numElem()]
+!!
+!!  This routine computes the volume of a body element. Note that for a
+!!  2-D plane strain element this is equivalent to the area of the element
+!!  (considering a unit thickness). This is computed as the following
+!!  determinant:
+!!
+!!    V   =  0.5 *  | x1  y1  1 |
+!!                  | x2  y2  1 |
+!!                  | x3  y3  1 |
+!!
+!!  where xj and yj are the (x,y) coordinates of node j of element i.
+! ------------------------------------------------------------------------
+FUNCTION fld_vol_elem_exc_ (i, exc) RESULT(vol)
+  INTEGER, INTENT(IN) :: i
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: vol
+
+  !> make sure the element number is valid
+  IF (i.LT.1 .OR. i.GT.fld_numElem()) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    vol = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  vol = fld_volElem(i)
+
+END FUNCTION fld_vol_elem_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for material (non-exception checking)
+!!
+!!  \param  i     Element number
+!!
+!!  \return m     Material number
+!!
+!!  This routine determines the material number associated with element i
+! ------------------------------------------------------------------------
+FUNCTION fld_get_material_ (i) RESULT(m)
+  INTEGER, INTENT(IN) :: i
+  INTEGER :: m
+
+  m = elements(i)%mtl
+
+END FUNCTION fld_get_material_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for material (exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  exc   Error code
+!!
+!!  \return m     Material number
+!!
+!!  \exception  POSIT The element number is not in [1..fld_numElem()]
+!!
+!!  This routine determines the material number associated with element i
+! ------------------------------------------------------------------------
+FUNCTION fld_get_material_exc_ (i, exc) RESULT(m)
+  INTEGER, INTENT(IN) :: i
+  INTEGER, INTENT(OUT) :: exc
+  INTEGER :: m
+
+  !> check that the element number is within the bounds of the elements
+  !! list
+  IF ( i.LT.1 .OR. i.GT.fld_numElem() ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    m = 0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  m = fld_getMaterial(i)
+
+END FUNCTION fld_get_material_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for material (non-exception checking)
+!!
+!!  \param  i     Node number
+!!  \param  m     Material number
+!!
+!!  This routine sets the material number associated with element i.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_material_ (i, m)
+  INTEGER, INTENT(IN) :: i
+  INTEGER, INTENT(IN) :: m
+
+  elements(i)%mtl = m
+
+END SUBROUTINE fld_set_material_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for material (exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  n     Material number
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the material number exceeds the
+!!                      number of materials
+!!  \exception  POSIT   The element number is not in [1..fld_numElem()]
+!!
+!!  This routine sets the material number associated with element i.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_material_exc_ (i, m, exc)
+  INTEGER, INTENT(IN) :: i
+  INTEGER, INTENT(IN) :: m
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the element number is within the bounds of the elements
+  !! list
+  IF ( i.LT.1 .OR. i.GT.fld_numElem() ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (m.LT.1 .OR. m.GT.mtl_numMtl()) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setMaterial(i, m)
+
+END SUBROUTINE fld_set_material_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for element stresses (non-exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Tensor index
+!!
+!!  \return s     Stress value
+!!
+!!  This routine determines the value of the stress for element
+!!  number i for tensor index j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_stress_elem_ (i,j) RESULT(s)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: s
+
+  s = elements(i)%stress%sig(j)
+
+END FUNCTION fld_get_stress_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for element stresses (exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Tensor index
+!!  \param  exc   Error code
+!!
+!!  \return s     Stress value
+!!
+!!  \exception  POSIT The element number is not in [1..fld_numElem()] or
+!!                    the tensor index is not in [1..NTNS]
+!!
+!!  This routine determines the value of the stress for element
+!!  number i for tensor index j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_stress_elem_exc_ (i,j, exc) RESULT(s)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: s
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the tensor index is within [1..NTNS]
+  IF ( i.LT.1 .OR. i.GT.fld_numElem() &
+        .OR. j.LT.1 .OR. j.GT.NTNS ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    s = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  s = fld_getStressElem(i,j)
+
+END FUNCTION fld_get_stress_elem_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for element stresses (non-exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Tensor index
+!!  \param  s     Stress value
+!!
+!!  This routine sets the value of the stress for element number i
+!!  for tensor index j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_stress_elem_ (i,j, s)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: s
+
+  elements(i)%stress%sig(j) = s
+
+END SUBROUTINE fld_set_stress_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for element stresses (exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Tensor index
+!!  \param  s     Stress value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the stress exceeds prescribed limits
+!!  \exception  POSIT   The element number is not in [1..fld_numElem()] or
+!!                      the tensor index is not in [1..NTNS]
+!!
+!!  This routine sets the value of the stress for node number i for
+!!  tensor index j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_stress_elem_exc_ (i,j, s, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: s
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the tensor index is within [1..NTNS]
+  IF ( i.LT.1 .OR. i.GT.fld_numElem() &
+        .OR. j.LT.1 .OR. j.GT.NTNS ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (s.LT.SIG_MIN .OR. s.GT.SIG_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setStressElem(i,j, s)
+
+END SUBROUTINE fld_set_stress_elem_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for element strains (non-exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Tensor index
+!!
+!!  \return s     Strain value
+!!
+!!  This routine determines the value of the strain for element
+!!  number i for tensor index j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_strain_elem_ (i,j) RESULT(s)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION :: s
+
+  s = elements(i)%strain%eps(j)
+
+END FUNCTION fld_get_strain_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Getter for element strains (exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Tensor index
+!!  \param  exc   Error code
+!!
+!!  \return s     Strain value
+!!
+!!  \exception  POSIT The element number is not in [1..fld_numElem()] or
+!!                    the tensor index is not in [1..NTNS]
+!!
+!!  This routine determines the value of the strain for element
+!!  number i for tensor index j.
+! ------------------------------------------------------------------------
+FUNCTION fld_get_strain_elem_exc_ (i,j, exc) RESULT(s)
+  INTEGER, INTENT(IN) :: i,j
+  INTEGER, INTENT(OUT) :: exc
+  DOUBLE PRECISION :: s
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the tensor index is within [1..NTNS]
+  IF ( i.LT.1 .OR. i.GT.fld_numElem() &
+        .OR. j.LT.1 .OR. j.GT.NTNS ) THEN
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    s = 0.d0
+    RETURN
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  s = fld_getStrainElem(i,j)
+
+END FUNCTION fld_get_strain_elem_exc_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for element strains (non-exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Tensor index
+!!  \param  s     Strain value
+!!
+!!  This routine sets the value of the strain for element number i
+!!  for tensor index j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_strain_elem_ (i,j, s)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: s
+
+  elements(i)%strain%eps(j) = s
+
+END SUBROUTINE fld_set_strain_elem_
+
+
+! ------------------------------------------------------------------------
+!>  \brief Setter for element strains (exception checking)
+!!
+!!  \param  i     Element number
+!!  \param  j     Tensor index
+!!  \param  s     Strain value
+!!  \param  exc   Error code
+!!
+!!  \exception  EXCEED  The value of the strain exceeds prescribed limits
+!!  \exception  POSIT   The element number is not in [1..fld_numElem()] or
+!!                      the tensor index is not in [1..NTNS]
+!!
+!!  This routine sets the value of the strain for element number i for
+!!  tensor index j.
+! ------------------------------------------------------------------------
+SUBROUTINE fld_set_strain_elem_exc_ (i,j, s, exc)
+  INTEGER, INTENT(IN) :: i,j
+  DOUBLE PRECISION, INTENT(IN) :: s
+  INTEGER, INTENT(OUT) :: exc
+
+  !> check that the element number is within the bounds of the elements
+  !! list and that the tensor index is within [1..NTNS]
+  IF ( i.LT.1 .OR. i.GT.fld_numElem() &
+        .OR. j.LT.1 .OR. j.GT.NTNS ) THEN
+
+    exc=POSIT
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE IF (s.LT.STR_MIN .OR. s.GT.STR_MAX) THEN
+
+    exc=EXCEED
+    CALL log_printLogMsg(exc,sdr)
+    RETURN
+
+  ELSE
+    exc=OK
+  END IF
+
+  !> call non-exception version
+  CALL fld_setStrainElem(i,j, s)
+
+END SUBROUTINE fld_set_strain_elem_exc_
+
+
+
+! ************************************************************************
+! LOCAL FUNCTIONS
+! ************************************************************************
+
+! none
+
+END MODULE field_data