xref: /petsc/src/sys/objects/ftn-custom/zoptionsf.c (revision 519f805a543c2a7f195bcba21173bb2cdfadb956)
19306f9a3SSatish Balay /*
29306f9a3SSatish Balay   This file contains Fortran stubs for Options routines.
39306f9a3SSatish Balay   These are not generated automatically since they require passing strings
49306f9a3SSatish Balay   between Fortran and C.
59306f9a3SSatish Balay */
69306f9a3SSatish Balay 
7b45d2f2cSJed Brown #include <petsc-private/fortranimpl.h>
89306f9a3SSatish Balay 
9*519f805aSKarl Rupp #if defined(PETSC_HAVE_FORTRAN_CAPS)
1047340559SBarry Smith #define petscoptionsgetenumprivate_        PETSCOPTIONSGETENUMPRIVATE
1108f86b60SJed Brown #define petscoptionsgetbool_               PETSCOPTIONSGETBOOL
129306f9a3SSatish Balay #define petscoptionsgetintarray_           PETSCOPTIONSGETINTARRAY
139306f9a3SSatish Balay #define petscoptionssetvalue_              PETSCOPTIONSSETVALUE
149306f9a3SSatish Balay #define petscoptionsclearvalue_            PETSCOPTIONSCLEARVALUE
159306f9a3SSatish Balay #define petscoptionshasname_               PETSCOPTIONSHASNAME
169306f9a3SSatish Balay #define petscoptionsgetint_                PETSCOPTIONSGETINT
179306f9a3SSatish Balay #define petscoptionsgetreal_               PETSCOPTIONSGETREAL
189306f9a3SSatish Balay #define petscoptionsgetrealarray_          PETSCOPTIONSGETREALARRAY
199306f9a3SSatish Balay #define petscoptionsgetstring_             PETSCOPTIONSGETSTRING
209306f9a3SSatish Balay #define petscgetprogramname                PETSCGETPROGRAMNAME
219306f9a3SSatish Balay #define petscoptionsinsertfile_            PETSCOPTIONSINSERTFILE
22a542b6e8SBarry Smith #define petscoptionsclear_                 PETSCOPTIONSCLEAR
23ab66e762SBarry Smith #define petscoptionsinsertstring_          PETSCOPTIONSINSERTSTRING
243a15af8cSBlaise Bourdin #define petscoptionsview_                  PETSCOPTIONSVIEW
259306f9a3SSatish Balay #elif !defined(PETSC_HAVE_FORTRAN_UNDERSCORE)
2647340559SBarry Smith #define petscoptionsgetenumprivate_        petscoptionsgetenumprivate
2708f86b60SJed Brown #define petscoptionsgetbool_               petscoptionsgetbool
289306f9a3SSatish Balay #define petscoptionssetvalue_              petscoptionssetvalue
299306f9a3SSatish Balay #define petscoptionsclearvalue_            petscoptionsclearvalue
309306f9a3SSatish Balay #define petscoptionshasname_               petscoptionshasname
319306f9a3SSatish Balay #define petscoptionsgetint_                petscoptionsgetint
329306f9a3SSatish Balay #define petscoptionsgetreal_               petscoptionsgetreal
339306f9a3SSatish Balay #define petscoptionsgetrealarray_          petscoptionsgetrealarray
349306f9a3SSatish Balay #define petscoptionsgetstring_             petscoptionsgetstring
359306f9a3SSatish Balay #define petscoptionsgetintarray_           petscoptionsgetintarray
369306f9a3SSatish Balay #define petscgetprogramname_               petscgetprogramname
379306f9a3SSatish Balay #define petscoptionsinsertfile_            petscoptionsinsertfile
38a542b6e8SBarry Smith #define petscoptionsclear_                 petscoptionsclear
39ab66e762SBarry Smith #define petscoptionsinsertstring_          petscoptionsinsertstring
403a15af8cSBlaise Bourdin #define petscoptionsview_                  petscoptionsview
419306f9a3SSatish Balay #endif
429306f9a3SSatish Balay 
439306f9a3SSatish Balay EXTERN_C_BEGIN
449306f9a3SSatish Balay 
459306f9a3SSatish Balay /* ---------------------------------------------------------------------*/
469306f9a3SSatish Balay 
47ab66e762SBarry Smith void PETSC_STDCALL petscoptionsinsertstring_(CHAR file PETSC_MIXED_LEN(len),PetscErrorCode *ierr PETSC_END_LEN(len))
48ab66e762SBarry Smith {
49ab66e762SBarry Smith   char *c1;
50ab66e762SBarry Smith 
51ab66e762SBarry Smith   FIXCHAR(file,len,c1);
52ab66e762SBarry Smith   *ierr = PetscOptionsInsertString(c1);
53ab66e762SBarry Smith   FREECHAR(file,c1);
54ab66e762SBarry Smith }
55ab66e762SBarry Smith 
56ace3abfcSBarry Smith void PETSC_STDCALL petscoptionsinsertfile_(MPI_Fint *comm,CHAR file PETSC_MIXED_LEN(len),PetscBool  *require,PetscErrorCode *ierr PETSC_END_LEN(len))
579306f9a3SSatish Balay {
589306f9a3SSatish Balay   char *c1;
599306f9a3SSatish Balay 
609306f9a3SSatish Balay   FIXCHAR(file,len,c1);
619b754dc9SBarry Smith   *ierr = PetscOptionsInsertFile(MPI_Comm_f2c(*comm),c1,*require);
629306f9a3SSatish Balay   FREECHAR(file,c1);
639306f9a3SSatish Balay }
649306f9a3SSatish Balay 
659306f9a3SSatish Balay void PETSC_STDCALL petscoptionssetvalue_(CHAR name PETSC_MIXED_LEN(len1),CHAR value PETSC_MIXED_LEN(len2),
669306f9a3SSatish Balay                    PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
679306f9a3SSatish Balay {
689306f9a3SSatish Balay   char *c1,*c2;
699306f9a3SSatish Balay 
709306f9a3SSatish Balay   FIXCHAR(name,len1,c1);
719306f9a3SSatish Balay   FIXCHAR(value,len2,c2);
729306f9a3SSatish Balay   *ierr = PetscOptionsSetValue(c1,c2);
739306f9a3SSatish Balay   FREECHAR(name,c1);
749306f9a3SSatish Balay   FREECHAR(value,c2);
759306f9a3SSatish Balay }
769306f9a3SSatish Balay 
77a542b6e8SBarry Smith void PETSC_STDCALL petscoptionsclear_(PetscErrorCode *ierr)
78a542b6e8SBarry Smith {
79a542b6e8SBarry Smith   *ierr = PetscOptionsClear();
80a542b6e8SBarry Smith }
81a542b6e8SBarry Smith 
829306f9a3SSatish Balay void PETSC_STDCALL petscoptionsclearvalue_(CHAR name PETSC_MIXED_LEN(len),PetscErrorCode *ierr PETSC_END_LEN(len))
839306f9a3SSatish Balay {
849306f9a3SSatish Balay   char *c1;
859306f9a3SSatish Balay 
869306f9a3SSatish Balay   FIXCHAR(name,len,c1);
879306f9a3SSatish Balay   *ierr = PetscOptionsClearValue(c1);
889306f9a3SSatish Balay   FREECHAR(name,c1);
899306f9a3SSatish Balay }
909306f9a3SSatish Balay 
919306f9a3SSatish Balay void PETSC_STDCALL petscoptionshasname_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
92ace3abfcSBarry Smith                     PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
939306f9a3SSatish Balay {
949306f9a3SSatish Balay   char *c1,*c2;
959306f9a3SSatish Balay 
969306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
979306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
989306f9a3SSatish Balay   *ierr = PetscOptionsHasName(c1,c2,flg);
999306f9a3SSatish Balay   FREECHAR(pre,c1);
1009306f9a3SSatish Balay   FREECHAR(name,c2);
1019306f9a3SSatish Balay }
1029306f9a3SSatish Balay 
1039306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetint_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
104ace3abfcSBarry Smith                     PetscInt *ivalue,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1059306f9a3SSatish Balay {
1069306f9a3SSatish Balay   char *c1,*c2;
107ace3abfcSBarry Smith   PetscBool  flag;
1089306f9a3SSatish Balay 
1099306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1109306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1117c363081SBarry Smith   *ierr = PetscOptionsGetInt(c1,c2,ivalue,&flag);
1125c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1139306f9a3SSatish Balay   FREECHAR(pre,c1);
1149306f9a3SSatish Balay   FREECHAR(name,c2);
1159306f9a3SSatish Balay }
1169306f9a3SSatish Balay 
11747340559SBarry Smith void PETSC_STDCALL petscoptionsgetenumprivate_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),const char *const*list,
11847340559SBarry Smith                     PetscEnum *ivalue,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
11947340559SBarry Smith {
12047340559SBarry Smith   char *c1,*c2;
12147340559SBarry Smith   PetscBool  flag;
12247340559SBarry Smith 
12347340559SBarry Smith   FIXCHAR(pre,len1,c1);
12447340559SBarry Smith   FIXCHAR(name,len2,c2);
12547340559SBarry Smith   *ierr = PetscOptionsGetEnum(c1,c2,list,ivalue,&flag);
12647340559SBarry Smith   if (!FORTRANNULLBOOL(flg)) *flg = flag;
12747340559SBarry Smith   FREECHAR(pre,c1);
12847340559SBarry Smith   FREECHAR(name,c2);
12947340559SBarry Smith }
13047340559SBarry Smith 
13108f86b60SJed Brown void PETSC_STDCALL petscoptionsgetbool_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
132ace3abfcSBarry Smith                     PetscBool  *ivalue,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1339306f9a3SSatish Balay {
1349306f9a3SSatish Balay   char *c1,*c2;
135ace3abfcSBarry Smith   PetscBool  flag;
1369306f9a3SSatish Balay 
1379306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1389306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
139acfcf0e5SJed Brown   *ierr = PetscOptionsGetBool(c1,c2,ivalue,&flag);
1405c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1419306f9a3SSatish Balay   FREECHAR(pre,c1);
1429306f9a3SSatish Balay   FREECHAR(name,c2);
1439306f9a3SSatish Balay }
1449306f9a3SSatish Balay 
1459306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetreal_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
146ace3abfcSBarry Smith                     PetscReal *dvalue,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1479306f9a3SSatish Balay {
1489306f9a3SSatish Balay   char *c1,*c2;
149ace3abfcSBarry Smith   PetscBool  flag;
1509306f9a3SSatish Balay 
1519306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1529306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1537c363081SBarry Smith   *ierr = PetscOptionsGetReal(c1,c2,dvalue,&flag);
1545c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1559306f9a3SSatish Balay   FREECHAR(pre,c1);
1569306f9a3SSatish Balay   FREECHAR(name,c2);
1579306f9a3SSatish Balay }
1589306f9a3SSatish Balay 
1599306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetrealarray_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
160ace3abfcSBarry Smith                 PetscReal *dvalue,PetscInt *nmax,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1619306f9a3SSatish Balay {
1629306f9a3SSatish Balay   char *c1,*c2;
163ace3abfcSBarry Smith   PetscBool  flag;
1649306f9a3SSatish Balay 
1659306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1669306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1677c363081SBarry Smith   *ierr = PetscOptionsGetRealArray(c1,c2,dvalue,nmax,&flag);
1685c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1699306f9a3SSatish Balay   FREECHAR(pre,c1);
1709306f9a3SSatish Balay   FREECHAR(name,c2);
1719306f9a3SSatish Balay }
1729306f9a3SSatish Balay 
1739306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetintarray_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
174ace3abfcSBarry Smith                    PetscInt *dvalue,PetscInt *nmax,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1759306f9a3SSatish Balay {
1769306f9a3SSatish Balay   char *c1,*c2;
177ace3abfcSBarry Smith   PetscBool  flag;
1789306f9a3SSatish Balay 
1799306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1809306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1817c363081SBarry Smith   *ierr = PetscOptionsGetIntArray(c1,c2,dvalue,nmax,&flag);
1825c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1839306f9a3SSatish Balay   FREECHAR(pre,c1);
1849306f9a3SSatish Balay   FREECHAR(name,c2);
1859306f9a3SSatish Balay }
1869306f9a3SSatish Balay 
1879306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetstring_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
188ace3abfcSBarry Smith                     CHAR string PETSC_MIXED_LEN(len),PetscBool  *flg,
1899306f9a3SSatish Balay                     PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2) PETSC_END_LEN(len))
1909306f9a3SSatish Balay {
1919306f9a3SSatish Balay   char *c1,*c2,*c3;
1924610e317SSatish Balay   size_t len3;
193ace3abfcSBarry Smith   PetscBool  flag;
1949306f9a3SSatish Balay 
1959306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1969306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1979306f9a3SSatish Balay   c3   = string;
1989306f9a3SSatish Balay   len3 = len - 1;
1999306f9a3SSatish Balay 
2007c363081SBarry Smith   *ierr = PetscOptionsGetString(c1,c2,c3,len3,&flag);
2015c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
2029306f9a3SSatish Balay   FREECHAR(pre,c1);
2039306f9a3SSatish Balay   FREECHAR(name,c2);
2047c363081SBarry Smith   FIXRETURNCHAR(flag,string,len);
2059306f9a3SSatish Balay }
2069306f9a3SSatish Balay 
2079306f9a3SSatish Balay void PETSC_STDCALL petscgetprogramname_(CHAR name PETSC_MIXED_LEN(len_in),PetscErrorCode *ierr PETSC_END_LEN(len_in))
2089306f9a3SSatish Balay {
2099306f9a3SSatish Balay   char *tmp;
2104610e317SSatish Balay   size_t len;
2119306f9a3SSatish Balay   tmp = name;
2129306f9a3SSatish Balay   len = len_in - 1;
2139306f9a3SSatish Balay   *ierr = PetscGetProgramName(tmp,len);
2147c363081SBarry Smith   FIXRETURNCHAR(PETSC_TRUE,name,len_in);
2159306f9a3SSatish Balay }
2169306f9a3SSatish Balay 
2173a15af8cSBlaise Bourdin void PETSC_STDCALL petscoptionsview_(PetscViewer *vin,PetscErrorCode *ierr)
2183a15af8cSBlaise Bourdin {
2193a15af8cSBlaise Bourdin   PetscViewer v;
2203a15af8cSBlaise Bourdin 
2213a15af8cSBlaise Bourdin   PetscPatchDefaultViewers_Fortran(vin,v);
2223a15af8cSBlaise Bourdin   *ierr = PetscOptionsView(v);
2233a15af8cSBlaise Bourdin }
2243a15af8cSBlaise Bourdin 
2259306f9a3SSatish Balay EXTERN_C_END
2269306f9a3SSatish Balay 
227