Interface fortran::syscgetsetupinfof
Definition: syscCommonTypesF.fi (line 196)
Provide an interface to get a setup info type.
Members
- syscgetsetupinfof
- syscgetsetupinfof_a
- syscgetsetupinfof_ar
- syscgetsetupinfof_ard
- syscgetsetupinfof_ardt
- syscgetsetupinfof_ardtp
Public functions
Function syscgetsetupinfof
type(syscsetupinfof) function syscgetsetupinfof()
Provide a function to get a setup info type.
Analysis type will be set to steady. Restarts supported flag will be set to false. Dimension will be set to 3. Time integration will be set to implicit.
Returns:
a SyscSetupInfoF type.
Return type: type(syscsetupinfof) function
Function syscgetsetupinfof_a
type(syscsetupinfof) function syscgetsetupinfof_a(analysisType)
Provide a function to get a setup info type.
Parameters:
- analysisType: - analysis type.
Restarts supported flag will be set to false. Dimension will be set to 3. Time integration will be set to implicit.
Returns:
a SyscSetupInfoF type.
Parameters:
- analysisTypeanalysisType
Return type: type(syscsetupinfof) function
Function syscgetsetupinfof_ar
type(syscsetupinfof) function syscgetsetupinfof_ar(analysisType, restartsSupported)
Provide a function to get a setup info type.
Parameters:
- analysisType: - analysis type.
- restartsSupported: - restarts supported flag.
Dimension will be set to 3. Time integration will be set to implicit.
Returns:
a SyscSetupInfoF type.
Parameters:
- analysisTypeanalysisType
- restartsSupportedrestartsSupported
Return type: type(syscsetupinfof) function
Function syscgetsetupinfof_ard
type(syscsetupinfof) function syscgetsetupinfof_ard(analysisType, restartsSupported, dimension)
Provide a function to get a setup info type.
Parameters:
- analysisType: - analysis type.
- restartsSupported: - restarts supported flag.
- dimension: - participant dimension.
Time integration will be set to implicit.
Returns:
a SyscSetupInfoF type.
Parameters:
- analysisTypeanalysisType
- restartsSupportedrestartsSupported
- dimensiondimension
Return type: type(syscsetupinfof) function
Function syscgetsetupinfof_ardt
type(syscsetupinfof) function syscgetsetupinfof_ardt(analysisType, restartsSupported, dimension, timeIntegration)
Provide a function to get a setup info type.
Parameters:
- analysisType: - analysis type.
- restartsSupported: - restarts supported flag.
- dimension: - participant dimension.
- timeIntegration: - time integration method.
Returns:
a SyscSetupInfoF type.
Parameters:
- analysisTypeanalysisType
- restartsSupportedrestartsSupported
- dimensiondimension
- timeIntegrationtimeIntegration
Return type: type(syscsetupinfof) function
Function syscgetsetupinfof_ardtp
type(syscsetupinfof) function syscgetsetupinfof_ardtp(analysisType, restartsSupported, dimension, timeIntegration, participantType)
Provide a function to get a setup info type.
Parameters:
- analysisType: - analysis type.
- restartsSupported: - restarts supported flag.
- dimension: - participant dimension.
- timeIntegration: - time integration method.
- participantType: - participant type.
Returns:
a SyscSetupInfoF type.
Parameters:
- analysisTypeanalysisType
- restartsSupportedrestartsSupported
- dimensiondimension
- timeIntegrationtimeIntegration
- participantTypeparticipantType
Return type: type(syscsetupinfof) function