hm_read_eos_tabulated.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/.
!||====================================================================
!||    hm_read_eos_tabulated    ../starter/source/materials/eos/hm_read_eos_tabulated.F
!||--- called by ------------------------------------------------------
!||    hm_read_eos              ../starter/source/materials/eos/hm_read_eos.F
!||--- calls      -----------------------------------------------------
!||    ancmsg                   ../starter/source/output/message/message.F
!||    hm_get_floatv            ../starter/source/devtools/hm_reader/hm_get_floatv.F
!||    hm_get_intv              ../starter/source/devtools/hm_reader/hm_get_intv.F
!||    hm_option_is_encrypted   ../starter/source/devtools/hm_reader/hm_option_is_encrypted.F
!||--- uses       -----------------------------------------------------
!||    message_mod              ../starter/share/message_module/message_mod.F
!||    submodel_mod             ../starter/share/modules1/submodel_mod.F
!||====================================================================
      SUBROUTINE hm_read_eos_tabulated(IOUT,PM,UNITAB,IUNIT,LSUBMODEL,IMIDEOS,EOS_STRUCT)
C-----------------------------------------------
C   M o d u l e s
C-----------------------------------------------
      USE unitab_mod
      USE submodel_mod
      USE message_mod
      USE eos_param_mod , ONLY : eos_param_
C-----------------------------------------------
C   D e s c r i p t i o n
C-----------------------------------------------
C reading parameters for
C   IDEAL-GAS EQUATION OF STATE
C-----------------------------------------------
C   C o m m e n t s
C-----------------------------------------------
C  RHOI = PM(89)   -> provided by /MAT
C  RHOR = PM(01)   -> provided by /MAT (can be erased by EOS if present : obsolete)
C  => MU0 = RHO/RHOR-1.
C  PM(31) = P(MU0,E0) -> will be used to initialize diagonal of stress tensor SIG(1:3,*)
C-----------------------------------------------
C   I m p l i c i t   T y p e s
C-----------------------------------------------
#include      "implicit_f.inc"
C-----------------------------------------------
C   D u m m y   A r g u m e n t s
C-----------------------------------------------
      TYPE (UNIT_TYPE_),INTENT(IN) ::UNITAB 
      INTEGER IOUT,IUNIT
      my_real pm(npropm)
      TYPE(submodel_data), DIMENSION(NSUBMOD), INTENT(IN) :: LSUBMODEL
      INTEGER,INTENT(IN) :: IMIDEOS
      TYPE(eos_param_),INTENT(INOUT) :: EOS_STRUCT
C-----------------------------------------------
C   C o m m o n   B l o c k s
C-----------------------------------------------
#include      "param_c.inc"
C-----------------------------------------------
C   L o c a l   V a r i a b l e s
C-----------------------------------------------
      my_real ::   p0, e0, psh, rho0,mu0,rhoi,rhor,g0,ssp0,dpdmu,df
      my_real :: xscale_a, xscale_b, fscale_a, fscale_b
      LOGICAL :: IS_ENCRYPTED, IS_AVAILABLE, IS_AVAILABLE_RHO0
      INTEGER :: A_FUN_ID, B_FUN_ID
C-----------------------------------------------
C   S o u r c e   L i n e s
C-----------------------------------------------
      is_encrypted = .false.
      is_available = .false.
      is_available_rho0 = .false.
 
      CALL hm_option_is_encrypted(is_encrypted)
 
      CALL hm_get_intv  ('A_FUNC'  ,a_fun_id  ,is_available,lsubmodel)
      CALL hm_get_intv  ('B_FUNC'  ,b_fun_id  ,is_available,lsubmodel)
      
      CALL hm_get_floatv('XscaleA', xscale_a, is_available,lsubmodel,unitab)
      CALL hm_get_floatv('XscaleB', xscale_b, is_available,lsubmodel,unitab)
      
      CALL hm_get_floatv('FscaleA', fscale_a, is_available,lsubmodel,unitab)              
      CALL hm_get_floatv('FscaleB', fscale_b, is_available,lsubmodel,unitab)                    
 
      CALL hm_get_floatv('PSH', psh, is_available,lsubmodel,unitab)
      CALL hm_get_floatv('E0', e0, is_available,lsubmodel,unitab)
      CALL hm_get_floatv('Refer_Rho', rho0, is_available_rho0,lsubmodel,unitab)
 
      !MANAGING INPUT ERRORS :
      IF(a_fun_id+b_fun_id == 0)THEN
         CALL ancmsg(msgid=67,msgtype=msgerror,anmode=aninfo,
     .               i1=imideos,
     .               c1='/EOS/TABULATED',
     .               c2='NO INPUT FUNCTION')
      ENDIF
      
      IF(is_available_rho0 .AND. rho0 < zero)THEN
         CALL ancmsg(msgid=67,msgtype=msgerror,anmode=aninfo,
     .               i1=imideos,
     .               c1='/EOS/TABULATED',
     .               c2='REFERENCE DENSITY MUST BE STRICTLY POSITIVE')
      ENDIF
      
      !REFERENCE DENSITY
      rhor = pm(1)
      rhoi = pm(89)
 
      IF(rho0 > zero) THEN
        rhor = rho0
        pm(1)= rho0 
      ELSE
        rho0=rhor                   
      ENDIF
 
      !COMPUTE P0 (stress tensor)
      IF(rhoi == zero)THEN
        mu0 = zero ! error 683 already displayed
      ELSE
        IF(rhor /= zero)THEN
          mu0 = rhoi/rhor-one
        ELSE
          mu0 = zero ! error 683 already displayed
        ENDIF
      ENDIF
      
      IF(rhoi /= zero)THEN
        df = rhor/rhoi
      ELSE
        df = zero
      ENDIF
 
      p0 = zero ! A(MU0) + B(MU0)*E0
 
      !SSP0
      ssp0 = zero 
      g0 = zero
      rhoi = pm(89)
      dpdmu =  zero ! A'(MU0) + B'(MU0)*E0+B(MU0)/(ONE+MU0)/(ONE+MU0)*P0
 
      dpdmu=max(zero,dpdmu)
      IF(rhor > zero) ssp0 = sqrt((dpdmu + two_third*g0)/rhor) 
            
      !STORAGE    
      pm(23) = e0
      pm(27) = ssp0
      pm(32) = zero
      pm(88) = psh
      pm(31) = p0-psh
      pm(104)= p0-psh
 
      eos_struct%NUPARAM = 4
      eos_struct%NIPARAM = 2
      eos_struct%NFUNC = 0
      eos_struct%NTABLE = 0
      CALL eos_struct%CONSTRUCT() !allocations
 
      eos_struct%UPARAM(1) = xscale_a
      eos_struct%UPARAM(2) = xscale_b
      eos_struct%UPARAM(3) = fscale_a
      eos_struct%UPARAM(4) = fscale_b
 
      eos_struct%IPARAM(1) = a_fun_id
      eos_struct%IPARAM(2) = b_fun_id
 
      eos_struct%E0 = e0
      eos_struct%PSH = psh
 
      WRITE(iout,1000)
 
      IF(is_encrypted)THEN
        WRITE(iout,'(5X,A,//)')'CONFIDENTIAL DATA'
      ELSE
        WRITE(iout,1500)a_fun_id,xscale_a,fscale_a,b_fun_id,xscale_b,fscale_b,e0,psh
        IF(is_available_rho0)WRITE(iout,1501)pm(1)
      ENDIF
 
      RETURN
 1000 FORMAT(
     & 5x,'  TABULATED EOS     ',/,
     & 5x,'  -------------     ',/)
 1500 FORMAT(
     & 5x,'FUNCTION A IDENTIFIER . . . . . . . . . .=',1pg20.13/,
     & 5x,'XSCALE_A. . . . . . . . . . . . . . . . .=',1pg20.13/,
     & 5x,'FSCALE_A. . . . . . . . . . . . . . . . .=',1pg20.13/,
     & 5x,'FUNCTION B IDENTIFIER . . . . . . . . . .=',1pg20.13/,
     & 5x,'XSCALE_B. . . . . . . . . . . . . . . . .=',1pg20.13/,
     & 5x,'FSCALE_B. . . . . . . . . . . . . . . . .=',1pg20.13/,
     & 5x,'E0. . . . . . . . . . . . . . . . . . . .=',1pg20.13/,          
     & 5x,'PSH . . . . . . . . . . . . . . . . . . .=',1pg20.13)
 1501 FORMAT(     
     & 5x,'EOS REFERENCE DENSITY . . . . . . . . . .=',1pg20.13)       
 
      RETURN
 
      END SUBROUTINE hm_read_eos_tabulated