MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
definedmacros Module Reference

Functions/Subroutines

integer(i4b) function, public get_os ()
 Get operating system. More...
 
logical(lgp) function, public is_extended ()
 Determine if this is the extended version. More...
 
logical(lgp) function, public using_petsc ()
 Determine if using petsc. More...
 
logical(lgp) function, public using_netcdf ()
 Determine if using netcdf. More...
 

Function/Subroutine Documentation

◆ get_os()

integer(i4b) function, public definedmacros::get_os

Function to get the integer operating system enum value.

Returns
ios operating system enum
operating system

Definition at line 16 of file defmacro.F90.

17  ! -- local variables
18  integer(I4B) :: ios !< operating system
19  !
20  ! -- initialize ios
21  ios = osundef
22  !
23  ! -- set operating system variables
24 #ifdef __GFORTRAN__
25 # ifdef __linux__
26  ios = oslinux
27 # endif
28 # ifdef __APPLE__
29  ios = osmac
30 # endif
31 # ifdef _WIN32
32  ios = oswin
33 # endif
34 #endif
35 #ifdef __INTEL_COMPILER
36 # ifdef __linux__
37  ios = oslinux
38 # endif
39 # ifdef __APPLE__
40  ios = osmac
41 # endif
42 # ifdef _WIN32
43  ios = oswin
44 # endif
45 #endif
46  !
47  ! return
48  return
Here is the caller graph for this function:

◆ is_extended()

logical(lgp) function, public definedmacros::is_extended

Function to get a logical indicating if this is the extended version of MODFLOW.

Returns
isextended extended version logical
extended version logical

Definition at line 58 of file defmacro.F90.

59  ! -- return variables
60  logical(LGP) :: isextended !< extended version logical
61  ! -- local variables
62  logical(LGP) :: ispetsc
63  logical(LGP) :: isnetcdf
64  !
65  ! -- initialize isextended
66  isextended = .false.
67  !
68  ! -- check if using petsc
69  ispetsc = using_petsc()
70  !
71  ! -- check if using netcf
72  isnetcdf = using_netcdf()
73  !
74  !
75  if (ispetsc .EQV. .true. .OR. isnetcdf .EQV. .true.) then
76  isextended = .true.
77  end if
78  !
79  ! return
80  return
Here is the call graph for this function:
Here is the caller graph for this function:

◆ using_netcdf()

logical(lgp) function, public definedmacros::using_netcdf

Function to get a logical indicating if netcdf is being used.

Returns
netcdfused netcdf used logical
netcdf used logical

Definition at line 113 of file defmacro.F90.

114  ! -- return variable
115  logical(LGP) :: netcdfused !< netcdf used logical
116  !
117  ! -- initialize petscavail
118  netcdfused = .false.
119  !
120  ! -- set operating system variables
121 #ifdef __WITH_NETCDF__
122  netcdfused = .true.
123 #endif
124  !
125  ! return
126  return
Here is the caller graph for this function:

◆ using_petsc()

logical(lgp) function, public definedmacros::using_petsc

Function to get a logical indicating if petsc is being used.

Returns
petscused petsc used logical
petsc used logical

Definition at line 90 of file defmacro.F90.

91  ! -- return variable
92  logical(LGP) :: petscused !< petsc used logical
93  !
94  ! -- initialize petscavail
95  petscused = .false.
96  !
97  ! -- set operating system variables
98 #ifdef __WITH_PETSC__
99  petscused = .true.
100 #endif
101  !
102  ! return
103  return
Here is the caller graph for this function: