dynlib_mod.F

Go to the documentation of this file.

Copyright>        OpenRadioss
Copyright>        Copyright (C) 1986-2025 Altair Engineering Inc.
Copyright>
Copyright>        This program is free software: you can redistribute it and/or modify
Copyright>        it under the terms of the GNU Affero General Public License as published by
Copyright>        the Free Software Foundation, either version 3 of the License, or
Copyright>        (at your option) any later version.
Copyright>
Copyright>        This program is distributed in the hope that it will be useful,
Copyright>        but WITHOUT ANY WARRANTY; without even the implied warranty of
Copyright>        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Copyright>        GNU Affero General Public License for more details.
Copyright>
Copyright>        You should have received a copy of the GNU Affero General Public License
Copyright>        along with this program.  If not, see <https://www.gnu.org/licenses/>.
Copyright>
Copyright>
Copyright>        Commercial Alternative: Altair Radioss Software
Copyright>
Copyright>        As an alternative to this open-source version, Altair also offers Altair Radioss
Copyright>        software under a commercial license.  Contact Altair to discuss further if the
Copyright>        commercial version may interest you: https://www.altair.com/radioss/.
!||====================================================================
!||    dynlib_mod   ../engine/share/modules/dynlib_mod.F
!||--- called by ------------------------------------------------------
!||    arret        ../engine/source/system/arret.F
!||    radioss0     ../engine/source/engine/radioss0.F
!||    radioss2     ../engine/source/engine/radioss2.F
!||    resol        ../engine/source/engine/resol.F
!||====================================================================
      MODULE dynlib_mod
!$COMMENT
!       DYNLIB_MOD :
!           * define a structure DLIB_STRUCT in order to manage the user routine calls :
!               * up to 100 user routines (--> NBR_DLIB variable)
!               * DLIB_NAME_LEN : maximal user routine name length
!               * DLIB_NAME : name of the user routine
!               * DLIB_BOOL : boolean : true = user routine available
!           * initialize the DLIB_STRUCT structure
!               * pointer to the DLIB_STRUCT : ID_name_of_the_user_routine
!               * add the name of the user routine (%DLIB_NAME)
!               * the DLIB_BOOL boolean is initialized with the array DLIB_ARRAY :
!                               - DLIB_ARRAY is initialized in dyn_userlib.c
!
!           For a new user routine :
!              o create the pointer to DLIB_STRUCT struct : add a new ID_name_of_the_user_routine
!              o add the name of the user routine (%DLIB_NAME)
!              o manage the DLIB_ARRAY in dyn_userlib.c
!
!           DLIB_STRUCT organization :
!               (1) --> ENGINE_USER_CHECK
!               (2) --> ENGINE_USER_FINALIZE
!               (3) --> ENGINE_USER_INITIALIZE
!               (4:100) --> empty, not used
!$ENDCOMMENT
C-----------------------------------------------
C   m y _ r e a l
C-----------------------------------------------
#include "my_real.inc"
C-----------------------------------------------
C   D e r i v e d   T y p e   D e f i n i t i o n s
C-----------------------------------------------
        INTEGER, PARAMETER :: nbr_dlib=100
        INTEGER, PARAMETER :: dlib_name_len=100
        INTEGER, DIMENSION(NBR_DLIB) :: dlib_array
 
        TYPE dyn_lib_type
            CHARACTER(len=DLIB_NAME_LEN) :: dlib_name
            LOGICAL :: dlib_bool      
        END TYPE dyn_lib_type
    
        TYPE(dyn_lib_type),DIMENSION(:), ALLOCATABLE :: dlib_struct
 
        !   local user variables
        INTEGER :: ispmd_user   !   --> ispmd : proc ID
        INTEGER :: nspmd_user   !   --> nspmd : total number of mpi tasks
        INTEGER :: ntask_user   !   --> ntask : total number of openmp tasks
        INTEGER :: mstop_user    !   --> mstop : 0 = ok ; 1 = stop the run
        INTEGER :: ncycle_user  !   --> ncycle : number of cycle
        REAL(kind=8) :: tstop_user   !   --> tstop : stop time
        REAL(kind=8) :: tt_user      !   --> tt : current time
 
        !   pointer to the DLIB_STRUCT : ID_name_of_the_user_routine
        INTEGER, PARAMETER :: id_engine_user_check=1
        INTEGER, PARAMETER :: id_engine_user_finalize = 2
        INTEGER, PARAMETER :: id_engine_user_initialize = 3
 
        CONTAINS
!       -----------------------------------------------
!||====================================================================
!||    init_dyn_lib_struc   ../engine/share/modules/dynlib_mod.F
!||--- called by ------------------------------------------------------
!||    radioss0             ../engine/source/engine/radioss0.F
!||    radioss2             ../engine/source/engine/radioss2.F
!||====================================================================
        SUBROUTINE init_dyn_lib_struc(MODE)
!$COMMENT
!           INIT_DYN_LIB_STRUC description
!           INIT_DYN_LIB_STRUC initializes the name of user routines and 
!           the DLIB_BOOL flag available / non-available 
!$ENDCOMMENT
!       -----------------------------------------------
!           I m p l i c i t   T y p e s
!       -----------------------------------------------
#include      "implicit_f.inc"
        INTEGER :: I,MODE
!       -----------------------------------------------
        IF(mode==0) THEN
            DO i=1,nbr_dlib
                dlib_struct(i)%DLIB_NAME(1:dlib_name_len) = ''
                dlib_struct(i)%DLIB_BOOL=.false.
            ENDDO
       
        ELSE
            DO i=1,nbr_dlib
                IF(dlib_array(i)/=0) dlib_struct(i)%DLIB_BOOL=.true.
            ENDDO
 
            dlib_struct(id_engine_user_check)%DLIB_NAME(1:17) = "ENGINE_USER_CHECK"
            dlib_struct(id_engine_user_finalize)%DLIB_NAME(1:20) = "ENGINE_USER_FINALIZE"
            dlib_struct(id_engine_user_initialize)%DLIB_NAME(1:22) = "ENGINE_USER_INITIALIZE"
        ENDIF
 
        RETURN
        END SUBROUTINE init_dyn_lib_struc
        
        
      END MODULE dynlib_mod