xref: /petsc/src/sys/tutorials/ex9f.F90 (revision 9b88ac225e01f016352a5f4cd90e158abe5f5675)

!
!   Example of using PetscOptionsBegin in Fortran
#include "petsc/finclude/petscsys.h"
program ex9f
  use petscsys
  implicit none

  PetscReal, parameter                       :: PReal = 1.0
  integer, parameter                         :: Pr = Selected_Real_Kind(precision(PReal))
  PetscInt, parameter                        :: PInt = 1
  integer, parameter                         :: Pi = kind(PInt)

  PetscErrorCode                            :: ierr
  PetscBool                                 :: flg
  PetscInt                                  :: nopt = 3_Pi
  PetscBool                                 :: bvalue, bdefault = PETSC_TRUE
  PetscBool, dimension(:), pointer            :: barray
  PetscEnum                                 :: evalue, edefault = 2
  PetscInt                                  :: ivalue, idefault = 2_Pi
  PetscInt, dimension(:), pointer             :: iarray
  PetscReal                                 :: rvalue, rdefault = 1.23_Pr
  PetscReal, dimension(:), pointer            :: rarray
  PetscScalar                               :: svalue, sdefault = -4.56_Pr
  PetscScalar, dimension(:), pointer          :: sarray
  character(len=256)                        :: IOBuffer
  character(len=256)                        :: stvalue, stdefault
  character(len=256)                        :: list(6)

  PetscCallA(PetscInitialize(ierr))
  list(1) = 'a123   '
  list(2) = 'b456   '
  list(3) = 'c789   '
  list(4) = 'list   '
  list(5) = 'prefix_'
  list(6) = ''
  stdefault = 'oulala oulala'

  allocate (iarray(nopt), source=-1_Pi)
  allocate (rarray(nopt), source=-99.0_pr)
  allocate (barray(nopt), source=PETSC_FALSE)
  allocate (sarray(nopt))
  sarray = 123.456_Pr

  PetscCallA(PetscOptionsBegin(PETSC_COMM_WORLD, 'prefix_', 'Setting options for my application', 'Section 1', ierr))
  PetscCallA(PetscOptionsBool('-bool', 'Get an application bool', 'Man page', bdefault, bvalue, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The bool value was set to ",L1,"\n")') bvalue
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, IOBuffer, ierr))
  end if
  PetscCallA(PetscOptionsBoolArray('-boolarray', 'Get an application bool array', 'Man page', barray, nopt, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The bool array was set to ",*(L1," "))') barray
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, trim(IOBuffer)//"\n", ierr))
  end if
  PetscCallA(PetscOptionsEnum('-enum', 'Get an application enum', 'Man page', list, edefault, evalue, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The bool value was set to ",A,"\n")') trim(list(evalue + 1))
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, IOBuffer, ierr))
  end if
  PetscCallA(PetscOptionsInt('-int', 'Get an application int', 'Man page', idefault, ivalue, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The integer value was set to ",I8,"\n")') ivalue
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, IOBuffer, ierr))
  end if
  PetscCallA(PetscOptionsIntArray('-intarray', 'Get an application int array', 'Man page', iarray, nopt, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The integer array was set to ",*(I8," "))') iarray
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, trim(IOBuffer)//"\n", ierr))
  end if
  PetscCallA(PetscOptionsReal('-real', 'Get an application real', 'Man page', rdefault, rvalue, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The real value was set to ",ES12.5,"\n")') rvalue
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, IOBuffer, ierr))
  end if
  PetscCallA(PetscOptionsRealArray('-realarray', 'Get an application real array', 'Man page', rarray, nopt, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The real array was set to ",*(ES12.5," "))') rarray
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, trim(IOBuffer)//"\n", ierr))
  end if
  PetscCallA(PetscOptionsScalar('-scalar', 'Get an application scalar', 'Man page', sdefault, svalue, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The scalar value was set to ",ES12.5,"\n")') svalue
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, IOBuffer, ierr))
  end if
  PetscCallA(PetscOptionsScalarArray('-scalararray', 'Get an application scalar array', 'Man page', sarray, nopt, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The scalar array was set to ",*(ES12.5," "))') sarray
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, trim(IOBuffer)//"\n", ierr))
  end if
  PetscCallA(PetscOptionsString('-string', 'Get an application string', 'Man page', stdefault, stvalue, flg, ierr))
  if (flg) then
    write (IOBuffer, '("The string value was set to ",A,"\n")') trim(stvalue)
    PetscCallA(PetscPrintf(PETSC_COMM_WORLD, IOBuffer, ierr))
  end if
  PetscCallA(PetscOptionsEnd(ierr))

  deallocate (iarray)
  deallocate (rarray)
  deallocate (barray)
  deallocate (sarray)
  PetscCallA(PetscFinalize(ierr))
end program ex9f

!
!/*TEST
!
!   build:
!      requires: !complex
!
!   test:
!      output_file: output/empty.out
!
!   test:
!      suffix: 2
!      args: -prefix_int 22 -prefix_intarray 2-5 -prefix_real 2.34 -prefix_realarray -3,-4,5.5 -prefix_scalar 7.89 -prefix_scalararray 1.,2.,3. -prefix_bool no -prefix_boolarray 1,no,true -prefix_string This_is_a_test_of_the_emergency_alert_system
!
!TEST*/