cmiss.f90

Go to the documentation of this file.

MODULE cmiss

  USE iso_c_binding
  
  USE base_routines
  USE basis_routines
  USE comp_environment
  USE constants
  USE coordinate_routines
  USE generated_mesh_routines
  USE iso_varying_string
  USE kinds
  USE machine_constants
#ifndef NOMPIMOD
  USE mpi
#endif
  USE problem_routines
  USE region_routines
  USE strings
  USE types

#include "macros.h"

  IMPLICIT NONE

  PRIVATE

#ifdef NOMPIMOD
#include "mpif.h"
#endif

  !Module parameters

  INTEGER(INTG), PARAMETER :: cmfe_major_version = 0
  INTEGER(INTG), PARAMETER :: cmfe_minor_version = 4
  INTEGER(INTG), PARAMETER :: cmfe_revision_version = 0

  CHARACTER(LEN=MAXSTRLEN), PARAMETER :: cmfe_build_version = "$Rev"

  INTEGER(INTG), PARAMETER :: cmfe_return_error_code = 0
  INTEGER(INTG), PARAMETER :: cmfe_output_error = 1
  INTEGER(INTG), PARAMETER :: cmfe_trap_error = 2
  
  !Module types

  !Module variables

  INTEGER(INTG), SAVE :: cmfe_errorhandlingmode
 
  !Interfaces

  INTERFACE

    SUBROUTINE cmfe_initfatalhandler() BIND(C,NAME="cmfe_InitFatalHandler")
    END SUBROUTINE cmfe_initfatalhandler

    SUBROUTINE cmfe_resetfatalhandler() BIND(C,NAME="cmfe_ResetFatalHandler")
    END SUBROUTINE cmfe_resetfatalhandler
    
    SUBROUTINE cmfe_setfatalhandler() BIND(C,NAME="cmfe_SetFatalHandler")
    END SUBROUTINE cmfe_setfatalhandler

  END INTERFACE

  PUBLIC cmfe_major_version,cmfe_minor_version,cmfe_revision_version,cmfe_build_version

  PUBLIC cmfe_return_error_code,cmfe_output_error,cmfe_trap_error

  PUBLIC cmfe_errorhandlingmodeget_,cmfe_errorhandlingmodeset_
  
  PUBLIC cmfe_handleerror
  
  PUBLIC cmfe_finalise_,cmfe_initialise_

CONTAINS

  !
  !================================================================================================================================
  !

!!TODO Underscore to avoid name clash. Can be removed upon prefix rename.

  SUBROUTINE cmfe_errorhandlingmodeget_(errorHandlingMode,err,error,*)
  
    !Argument variables
    INTEGER(INTG), INTENT(OUT) :: errorHandlingMode
    INTEGER(INTG), INTENT(INOUT) :: err
    TYPE(varying_string), INTENT(INOUT) :: error
    !Local Variables

    enters("cmfe_ErrorHandlingModeGet_",err,error,*999)

    errorhandlingmode=cmfe_errorhandlingmode
    
    exits("cmfe_ErrorHandlingModeGet_")
    RETURN
999 errorsexits("",err,error)
    RETURN 1
    
  END SUBROUTINE cmfe_errorhandlingmodeget_

  !
  !================================================================================================================================
  !

!!TODO Underscore to avoid name clash. Can be removed upon prefix rename.

  SUBROUTINE cmfe_errorhandlingmodeset_(errorHandlingMode,err,error,*)
  
    !Argument variables
    INTEGER(INTG), INTENT(IN) :: errorHandlingMode
    INTEGER(INTG), INTENT(INOUT) :: err
    TYPE(varying_string), INTENT(INOUT) :: error
    !Local Variables
    TYPE(varying_string) :: localError
    
    enters("cmfe_ErrorHandlingModeSet",err,error,*999)

    SELECT CASE(errorhandlingmode)
    CASE(cmfe_return_error_code)
      cmfe_errorhandlingmode=cmfe_return_error_code
    CASE(cmfe_output_error)
      cmfe_errorhandlingmode=cmfe_output_error
    CASE(cmfe_trap_error)
      cmfe_errorhandlingmode=cmfe_trap_error
    CASE DEFAULT
      localerror="The supplied error handling mode of "//trim(numbertovstring(errorhandlingmode,"*",err,error))// &
        & " is invalid."
      CALL flagerror(localerror,err,error,*999)
    END SELECT

    exits("cmfe_ErrorHandlingModeSet_")
    RETURN
999 errorsexits("cmfe_ErrorHandlingModeSet_",err,error)
    RETURN 1
    
  END SUBROUTINE cmfe_errorhandlingmodeset_

  !
  !================================================================================================================================
  !

!!TODO Underscore to avoid name clash. Can be removed upon prefix rename.
  
  SUBROUTINE cmfe_finalise_(err,error,*)
  
    !Argument variables
    INTEGER(INTG), INTENT(INOUT) :: err
    TYPE(varying_string), INTENT(INOUT) :: error
    !Local Variables

    !Finalise the problems
    CALL problems_finalise(err,error,*999)
    !Finalise the regions
    CALL regions_finalise(err,error,*999)
    !Finalise the coordinate systems
    CALL coordinate_systems_finalise(err,error,*999)
    !Finalise bases
    CALL bases_finalise(err,error,*999)
    !Reset the signal handler
    CALL cmfe_resetfatalhandler()
    !Finalise computational enviroment
    CALL computational_environment_finalise(err,error,*999)
    !Finalise the base routines
    CALL base_routines_finalise(err,error,*999)
     
    RETURN
999 RETURN 1
    
  END SUBROUTINE cmfe_finalise_

  !
  !================================================================================================================================
  !

!!TODO Underscore to avoid name clash. Can be removed upon prefix rename.

  SUBROUTINE cmfe_initialise_(worldRegion,err,error,*)
  
    !Argument variables
    TYPE(region_type), POINTER :: worldRegion
    INTEGER(INTG), INTENT(INOUT) :: err
    TYPE(varying_string), INTENT(INOUT) :: error
    !Local Variables
    TYPE(varying_string) :: versionString

    !Initialise error mode
    cmfe_errorhandlingmode = cmfe_output_error !Default for now, maybe make CMFE_RETURN_ERROR_CODE the default
    !Initialise the base routines
    CALL base_routines_initialise(err,error,*999)
    !Intialise the computational environment
    CALL computational_environment_initialise(err,error,*999)
    !Setup signal handling
    CALL cmfe_initfatalhandler()
    CALL cmfe_setfatalhandler()
    IF(ASSOCIATED(worldregion)) THEN
      CALL flagerror("World region is already associated.",err,error,*999)
    ELSE
      !Intialise the bases
      CALL bases_initialise(err,error,*999)
      !Initialise the coordinate systems
      CALL coordinate_systems_initialise(err,error,*999)
      !Initialise the regions 
      CALL regions_initialise(worldregion,err,error,*999)
      !Initialise the problems
      CALL problems_initialise(err,error,*999)
      
      !Write out the CMISS version
      IF(computational_environment%MY_COMPUTATIONAL_NODE_NUMBER==0) THEN
        versionstring="OpenCMISS(Iron) version "//trim(numbertovstring(cmfe_major_version,"*",err,error))
        versionstring=versionstring//"."
        versionstring=versionstring//trim(numbertovstring(cmfe_minor_version,"*",err,error))
        versionstring=versionstring//"."
        versionstring=versionstring//trim(numbertovstring(cmfe_revision_version,"*",err,error))
        !versionString=versionString//" ("
        !versionString=versionString//TRIM(CMFE_BUILD_VERSION(6:))
        !versionString=versionString//" )"
        
        !WRITE(*,'(A)') CHAR(versionString)

      ENDIF
    ENDIF
    
    RETURN
999 RETURN 1
    
  END SUBROUTINE cmfe_initialise_

  !
  !================================================================================================================================
  !

  SUBROUTINE cmfe_handleerror(err,error)
  
    !Argument variables
    INTEGER(INTG), INTENT(INOUT) :: err
    TYPE(varying_string), INTENT(INOUT) :: error
    !Local Variables
    INTEGER(INTG) :: mpiError
    
    SELECT CASE(cmfe_errorhandlingmode)
    CASE(cmfe_return_error_code)
      !Do nothing
    CASE(cmfe_output_error)
      CALL writeerror(err,error,*999)
    CASE(cmfe_trap_error)
      CALL writeerror(err,error,*999)
      CALL mpi_abort(mpi_comm_world,err,mpierror)
      stop
    CASE DEFAULT
      !Do nothing
    END SELECT

    RETURN
999 RETURN

  END SUBROUTINE cmfe_handleerror
  
  !
  !================================================================================================================================
  !

END MODULE cmiss