syscCommonTypesF.fi | Ansys Developer Portal

module fortran
!
! Copyright 2023 ANSYS, Inc. 
! Unauthorized use, distribution, or duplication is prohibited.
!
! Provide free-form Fortran interface for
! System Coupling Participant Library.
!
! This interfaces file provides commonly-used types and parameters.
!
! ****** Parameter for string legth ***********************************
!
integer(kind=4), parameter :: SyscStrLen = 256
integer(kind=4), parameter :: SyscFilePathLen = 4096
!
! ****** Parameters for variable mesh locations ***********************
!
integer(kind=4), parameter :: SyscNode = 0
integer(kind=4), parameter :: SyscElement = 1
!
! ****** Parameters for variable tensor types *************************
!
integer(kind=4), parameter :: SyscScalar = 0
integer(kind=4), parameter :: SyscVector = 1
!
! ****** Parameters for region topologies *****************************
!
integer(kind=4), parameter :: SyscSurface = 2
integer(kind=4), parameter :: SyscVolume = 3
!
! ****** Parameters for region discretization types *******************
!
integer(kind=4), parameter :: SyscMeshRegion = 0
integer(kind=4), parameter :: SyscPointCloudRegion = 1
!
! *********** Parameters for interface side ***************************
!
integer(kind=4), parameter :: SyscInterfaceSide_One = 1
integer(kind=4), parameter :: SyscInterfaceSide_Two = 2
!
! *********************** Dimensionality ******************************
!! \brief Provide a structure for dimensionality
type :: syscdimensionalityf
  real(kind=8) :: length
  real(kind=8) :: time
  real(kind=8) :: mass
  real(kind=8) :: temperature
  real(kind=8) :: amountofsubstance
  real(kind=8) :: current
  real(kind=8) :: luminousintensity
  real(kind=8) :: angle
end type syscdimensionalityf
!
!**********************************************************************
!**********************************************************************
!
interface syscgetdimensionalityf
!
!**********************************************************************
!**********************************************************************
function syscgetdimensionalityf() result(ret)
!
  import :: syscdimensionalityf
  type(syscdimensionalityf) :: ret
!DIR$ IF DEFINED(_WIN32)
!DIR$ ATTRIBUTES DLLIMPORT :: syscGetDimensionalityF
!DIR$ ENDIF
end function syscgetdimensionalityf
!
end interface syscgetdimensionalityf
!
! *********************************************************************
! \brief Provide parameters for supported quantity types.
!
! Quantity type provides information about the physical meaning of
! the variable. This can be useful for detecting validation errors
! during the coupled analysis setup. If the variable does not match
! any of the provided quantity types, quantity type can be set to
! unspecified.
!
integer(kind=4), parameter :: syscunspecified = 0
integer(kind=4), parameter :: syscforce = 1
integer(kind=4), parameter :: syscincrementaldisplacement = 2
integer(kind=4), parameter :: sysctemperature = 3
integer(kind=4), parameter :: syscheatrate = 4
integer(kind=4), parameter :: syscheattransfercoefficient = 5
integer(kind=4), parameter :: syscconvectionreferencetemperature = 6
integer(kind=4), parameter :: syscmodeshape = 7
integer(kind=4), parameter :: syscelectricalconductivity = 8
!
! ****** Parameters for data type *************************************
!
integer(kind=4), parameter :: syscdatatype_real = 0
integer(kind=4), parameter :: syscdatatype_complex = 1
!
! ****** Parameters for participant solver's convergence status *******
!
integer(kind=4), parameter :: syscdiverging       = -1
integer(kind=4), parameter :: syscnotyetconverged = 0
integer(kind=4), parameter :: syscconverged       = 1
integer(kind=4), parameter :: sysccomplete        = 2
integer(kind=4), parameter :: syscnotevaluated    = 3
!
! ****** Parameters for analysis types ********************************
!
integer(kind=4), parameter :: syscsteady = 0
integer(kind=4), parameter :: sysctransient = 1
!
! *********************************************************************
!
type :: sysctimestepf
  integer(kind=8) :: timestepnumber
  real(kind=8) :: starttime 
  real(kind=8) :: timestepsize 
end type sysctimestepf
!
! ****** Parameters for return codes **********************************
!
integer(kind=4), parameter :: syscstatusok = 0
integer(kind=4), parameter :: syscstatuserror = 1
!
type :: syscerrorf
  integer(kind=4) :: retcode
  character(len=SyscStrLen) :: message
end type syscerrorf
!
! ****** Provide parameters for supported primitive types *************
!
integer(kind=4), parameter :: syscreal4 = 0
integer(kind=4), parameter :: syscreal8 = 1
integer(kind=4), parameter :: syscint4  = 2
integer(kind=4), parameter :: syscint8  = 3
!
! *********************************************************************
! *********************************************************************
type :: syscsetupinfof
  integer(kind=8) :: analysistype
  logical(kind=8) :: restartssupported
end type syscsetupinfof
!
!**********************************************************************
!**********************************************************************
!
interface syscgetsetupinfof
!
!**********************************************************************
!**********************************************************************
function syscgetsetupinfof() result(ret)
!
  import :: syscsetupinfof
  type(syscsetupinfof) :: ret
!
!DIR$ IF DEFINED(_WIN32)
!DIR$ ATTRIBUTES DLLIMPORT :: syscGetSetupInfoF
!DIR$ ENDIF
!
end function syscgetsetupinfof
!
!**********************************************************************
!**********************************************************************
function syscgetsetupinfof_a(analysisType) result(ret)
!
  import :: syscsetupinfof
  integer(kind=4), intent(in) :: analysistype
  type(syscsetupinfof) :: ret
!
!DIR$ IF DEFINED(_WIN32)
!DIR$ ATTRIBUTES DLLIMPORT :: syscGetSetupInfoF_A
!DIR$ ENDIF
!
end function syscgetsetupinfof_a
!
!**********************************************************************
!**********************************************************************
function syscgetsetupinfof_ar(analysisType, &
  restartsSupported) result(ret)
!
    import :: syscsetupinfof
    integer(kind=4), intent(in) :: analysistype
    logical, intent(in) :: restartssupported
    type(syscsetupinfof) :: ret
!
!DIR$ IF DEFINED(_WIN32)
!DIR$ ATTRIBUTES DLLIMPORT :: syscGetSetupInfoF_AR
!DIR$ ENDIF
!
  end function syscgetsetupinfof_ar
!
end interface syscgetsetupinfof
!
! *********************************************************************
! *********************************************************************
type :: syscsetupfileinfof
  character(len=SyscFilePathLen) :: setupfilename
  logical :: restartssupported
end type syscsetupfileinfof
!
!**********************************************************************
!**********************************************************************
!
interface syscgetsetupfileinfof
!
!**********************************************************************
!**********************************************************************
function syscgetsetupfileinfof(setupFileName) result(ret)
!
  import :: syscsetupfileinfof
  character(len=*), intent(in) :: setupfilename
  type(syscsetupfileinfof) :: ret
!
!DIR$ IF DEFINED(_WIN32)
!DIR$ ATTRIBUTES DLLIMPORT :: syscGetSetupFileInfoF
!DIR$ ENDIF
!
end function syscgetsetupfileinfof
!
end interface syscgetsetupfileinfof
!
! *********************************************************************
! *********************************************************************
type :: syscresultsinfof
  character(len=SyscFilePathLen) :: basefilename
end type syscresultsinfof
!
!**********************************************************************
!**********************************************************************
!
interface syscgetresultsinfof
!
!**********************************************************************
!**********************************************************************
function syscgetresultsinfof(baseFileName) result(ret)
  import :: syscresultsinfof
  character(len=*), intent(in) :: basefilename
  type(syscresultsinfof) :: ret
!DIR$ IF DEFINED(_WIN32)
!DIR$ ATTRIBUTES DLLIMPORT :: syscGetResultsInfoF
!DIR$ ENDIF
end function syscgetresultsinfof
!
end interface syscgetresultsinfof
!
 
end module fortran
System Coupling Fortran library 2023 R2

syscCommonTypesF

Connect with Ansys
