xref: /petsc/src/sys/objects/ftn-custom/zoptionsf.c (revision 665c2ded495bb9782a7454dcfef3abf1536c3670)
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>
8*665c2dedSJed Brown #include <petscviewer.h>
99306f9a3SSatish Balay 
10519f805aSKarl Rupp #if defined(PETSC_HAVE_FORTRAN_CAPS)
1147340559SBarry Smith #define petscoptionsgetenumprivate_        PETSCOPTIONSGETENUMPRIVATE
1208f86b60SJed Brown #define petscoptionsgetbool_               PETSCOPTIONSGETBOOL
139306f9a3SSatish Balay #define petscoptionsgetintarray_           PETSCOPTIONSGETINTARRAY
149306f9a3SSatish Balay #define petscoptionssetvalue_              PETSCOPTIONSSETVALUE
159306f9a3SSatish Balay #define petscoptionsclearvalue_            PETSCOPTIONSCLEARVALUE
169306f9a3SSatish Balay #define petscoptionshasname_               PETSCOPTIONSHASNAME
179306f9a3SSatish Balay #define petscoptionsgetint_                PETSCOPTIONSGETINT
189306f9a3SSatish Balay #define petscoptionsgetreal_               PETSCOPTIONSGETREAL
199306f9a3SSatish Balay #define petscoptionsgetrealarray_          PETSCOPTIONSGETREALARRAY
209306f9a3SSatish Balay #define petscoptionsgetstring_             PETSCOPTIONSGETSTRING
219306f9a3SSatish Balay #define petscgetprogramname                PETSCGETPROGRAMNAME
229306f9a3SSatish Balay #define petscoptionsinsertfile_            PETSCOPTIONSINSERTFILE
23a542b6e8SBarry Smith #define petscoptionsclear_                 PETSCOPTIONSCLEAR
24ab66e762SBarry Smith #define petscoptionsinsertstring_          PETSCOPTIONSINSERTSTRING
253a15af8cSBlaise Bourdin #define petscoptionsview_                  PETSCOPTIONSVIEW
269306f9a3SSatish Balay #elif !defined(PETSC_HAVE_FORTRAN_UNDERSCORE)
2747340559SBarry Smith #define petscoptionsgetenumprivate_        petscoptionsgetenumprivate
2808f86b60SJed Brown #define petscoptionsgetbool_               petscoptionsgetbool
299306f9a3SSatish Balay #define petscoptionssetvalue_              petscoptionssetvalue
309306f9a3SSatish Balay #define petscoptionsclearvalue_            petscoptionsclearvalue
319306f9a3SSatish Balay #define petscoptionshasname_               petscoptionshasname
329306f9a3SSatish Balay #define petscoptionsgetint_                petscoptionsgetint
339306f9a3SSatish Balay #define petscoptionsgetreal_               petscoptionsgetreal
349306f9a3SSatish Balay #define petscoptionsgetrealarray_          petscoptionsgetrealarray
359306f9a3SSatish Balay #define petscoptionsgetstring_             petscoptionsgetstring
369306f9a3SSatish Balay #define petscoptionsgetintarray_           petscoptionsgetintarray
379306f9a3SSatish Balay #define petscgetprogramname_               petscgetprogramname
389306f9a3SSatish Balay #define petscoptionsinsertfile_            petscoptionsinsertfile
39a542b6e8SBarry Smith #define petscoptionsclear_                 petscoptionsclear
40ab66e762SBarry Smith #define petscoptionsinsertstring_          petscoptionsinsertstring
413a15af8cSBlaise Bourdin #define petscoptionsview_                  petscoptionsview
429306f9a3SSatish Balay #endif
439306f9a3SSatish Balay 
449306f9a3SSatish Balay EXTERN_C_BEGIN
459306f9a3SSatish Balay 
469306f9a3SSatish Balay /* ---------------------------------------------------------------------*/
479306f9a3SSatish Balay 
48ab66e762SBarry Smith void PETSC_STDCALL petscoptionsinsertstring_(CHAR file PETSC_MIXED_LEN(len),PetscErrorCode *ierr PETSC_END_LEN(len))
49ab66e762SBarry Smith {
50ab66e762SBarry Smith   char *c1;
51ab66e762SBarry Smith 
52ab66e762SBarry Smith   FIXCHAR(file,len,c1);
53ab66e762SBarry Smith   *ierr = PetscOptionsInsertString(c1);
54ab66e762SBarry Smith   FREECHAR(file,c1);
55ab66e762SBarry Smith }
56ab66e762SBarry Smith 
57ace3abfcSBarry Smith void PETSC_STDCALL petscoptionsinsertfile_(MPI_Fint *comm,CHAR file PETSC_MIXED_LEN(len),PetscBool  *require,PetscErrorCode *ierr PETSC_END_LEN(len))
589306f9a3SSatish Balay {
599306f9a3SSatish Balay   char *c1;
609306f9a3SSatish Balay 
619306f9a3SSatish Balay   FIXCHAR(file,len,c1);
629b754dc9SBarry Smith   *ierr = PetscOptionsInsertFile(MPI_Comm_f2c(*comm),c1,*require);
639306f9a3SSatish Balay   FREECHAR(file,c1);
649306f9a3SSatish Balay }
659306f9a3SSatish Balay 
669306f9a3SSatish Balay void PETSC_STDCALL petscoptionssetvalue_(CHAR name PETSC_MIXED_LEN(len1),CHAR value PETSC_MIXED_LEN(len2),
679306f9a3SSatish Balay                    PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
689306f9a3SSatish Balay {
699306f9a3SSatish Balay   char *c1,*c2;
709306f9a3SSatish Balay 
719306f9a3SSatish Balay   FIXCHAR(name,len1,c1);
729306f9a3SSatish Balay   FIXCHAR(value,len2,c2);
739306f9a3SSatish Balay   *ierr = PetscOptionsSetValue(c1,c2);
749306f9a3SSatish Balay   FREECHAR(name,c1);
759306f9a3SSatish Balay   FREECHAR(value,c2);
769306f9a3SSatish Balay }
779306f9a3SSatish Balay 
78a542b6e8SBarry Smith void PETSC_STDCALL petscoptionsclear_(PetscErrorCode *ierr)
79a542b6e8SBarry Smith {
80a542b6e8SBarry Smith   *ierr = PetscOptionsClear();
81a542b6e8SBarry Smith }
82a542b6e8SBarry Smith 
839306f9a3SSatish Balay void PETSC_STDCALL petscoptionsclearvalue_(CHAR name PETSC_MIXED_LEN(len),PetscErrorCode *ierr PETSC_END_LEN(len))
849306f9a3SSatish Balay {
859306f9a3SSatish Balay   char *c1;
869306f9a3SSatish Balay 
879306f9a3SSatish Balay   FIXCHAR(name,len,c1);
889306f9a3SSatish Balay   *ierr = PetscOptionsClearValue(c1);
899306f9a3SSatish Balay   FREECHAR(name,c1);
909306f9a3SSatish Balay }
919306f9a3SSatish Balay 
929306f9a3SSatish Balay void PETSC_STDCALL petscoptionshasname_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
93ace3abfcSBarry Smith                     PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
949306f9a3SSatish Balay {
959306f9a3SSatish Balay   char *c1,*c2;
969306f9a3SSatish Balay 
979306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
989306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
999306f9a3SSatish Balay   *ierr = PetscOptionsHasName(c1,c2,flg);
1009306f9a3SSatish Balay   FREECHAR(pre,c1);
1019306f9a3SSatish Balay   FREECHAR(name,c2);
1029306f9a3SSatish Balay }
1039306f9a3SSatish Balay 
1049306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetint_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
105ace3abfcSBarry Smith                     PetscInt *ivalue,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1069306f9a3SSatish Balay {
1079306f9a3SSatish Balay   char      *c1,*c2;
108ace3abfcSBarry Smith   PetscBool flag;
1099306f9a3SSatish Balay 
1109306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1119306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1127c363081SBarry Smith   *ierr = PetscOptionsGetInt(c1,c2,ivalue,&flag);
1135c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1149306f9a3SSatish Balay   FREECHAR(pre,c1);
1159306f9a3SSatish Balay   FREECHAR(name,c2);
1169306f9a3SSatish Balay }
1179306f9a3SSatish Balay 
11847340559SBarry Smith void PETSC_STDCALL petscoptionsgetenumprivate_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),const char *const*list,
11947340559SBarry Smith                     PetscEnum *ivalue,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
12047340559SBarry Smith {
12147340559SBarry Smith   char      *c1,*c2;
12247340559SBarry Smith   PetscBool flag;
12347340559SBarry Smith 
12447340559SBarry Smith   FIXCHAR(pre,len1,c1);
12547340559SBarry Smith   FIXCHAR(name,len2,c2);
12647340559SBarry Smith   *ierr = PetscOptionsGetEnum(c1,c2,list,ivalue,&flag);
12747340559SBarry Smith   if (!FORTRANNULLBOOL(flg)) *flg = flag;
12847340559SBarry Smith   FREECHAR(pre,c1);
12947340559SBarry Smith   FREECHAR(name,c2);
13047340559SBarry Smith }
13147340559SBarry Smith 
13208f86b60SJed Brown void PETSC_STDCALL petscoptionsgetbool_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
133ace3abfcSBarry Smith                     PetscBool  *ivalue,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1349306f9a3SSatish Balay {
1359306f9a3SSatish Balay   char      *c1,*c2;
136ace3abfcSBarry Smith   PetscBool flag;
1379306f9a3SSatish Balay 
1389306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1399306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
140acfcf0e5SJed Brown   *ierr = PetscOptionsGetBool(c1,c2,ivalue,&flag);
1415c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1429306f9a3SSatish Balay   FREECHAR(pre,c1);
1439306f9a3SSatish Balay   FREECHAR(name,c2);
1449306f9a3SSatish Balay }
1459306f9a3SSatish Balay 
1469306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetreal_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
147ace3abfcSBarry Smith                     PetscReal *dvalue,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1489306f9a3SSatish Balay {
1499306f9a3SSatish Balay   char *c1,*c2;
150ace3abfcSBarry Smith   PetscBool  flag;
1519306f9a3SSatish Balay 
1529306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1539306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1547c363081SBarry Smith   *ierr = PetscOptionsGetReal(c1,c2,dvalue,&flag);
1555c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1569306f9a3SSatish Balay   FREECHAR(pre,c1);
1579306f9a3SSatish Balay   FREECHAR(name,c2);
1589306f9a3SSatish Balay }
1599306f9a3SSatish Balay 
1609306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetrealarray_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
161ace3abfcSBarry Smith                 PetscReal *dvalue,PetscInt *nmax,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1629306f9a3SSatish Balay {
1639306f9a3SSatish Balay   char      *c1,*c2;
164ace3abfcSBarry Smith   PetscBool flag;
1659306f9a3SSatish Balay 
1669306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1679306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1687c363081SBarry Smith   *ierr = PetscOptionsGetRealArray(c1,c2,dvalue,nmax,&flag);
1695c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1709306f9a3SSatish Balay   FREECHAR(pre,c1);
1719306f9a3SSatish Balay   FREECHAR(name,c2);
1729306f9a3SSatish Balay }
1739306f9a3SSatish Balay 
1749306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetintarray_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
175ace3abfcSBarry Smith                    PetscInt *dvalue,PetscInt *nmax,PetscBool  *flg,PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2))
1769306f9a3SSatish Balay {
1779306f9a3SSatish Balay   char      *c1,*c2;
178ace3abfcSBarry Smith   PetscBool flag;
1799306f9a3SSatish Balay 
1809306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1819306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1827c363081SBarry Smith   *ierr = PetscOptionsGetIntArray(c1,c2,dvalue,nmax,&flag);
1835c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
1849306f9a3SSatish Balay   FREECHAR(pre,c1);
1859306f9a3SSatish Balay   FREECHAR(name,c2);
1869306f9a3SSatish Balay }
1879306f9a3SSatish Balay 
1889306f9a3SSatish Balay void PETSC_STDCALL petscoptionsgetstring_(CHAR pre PETSC_MIXED_LEN(len1),CHAR name PETSC_MIXED_LEN(len2),
189ace3abfcSBarry Smith                     CHAR string PETSC_MIXED_LEN(len),PetscBool  *flg,
1909306f9a3SSatish Balay                     PetscErrorCode *ierr PETSC_END_LEN(len1) PETSC_END_LEN(len2) PETSC_END_LEN(len))
1919306f9a3SSatish Balay {
1929306f9a3SSatish Balay   char      *c1,*c2,*c3;
1934610e317SSatish Balay   size_t    len3;
194ace3abfcSBarry Smith   PetscBool flag;
1959306f9a3SSatish Balay 
1969306f9a3SSatish Balay   FIXCHAR(pre,len1,c1);
1979306f9a3SSatish Balay   FIXCHAR(name,len2,c2);
1989306f9a3SSatish Balay   c3   = string;
1999306f9a3SSatish Balay   len3 = len - 1;
2009306f9a3SSatish Balay 
2017c363081SBarry Smith   *ierr = PetscOptionsGetString(c1,c2,c3,len3,&flag);
2025c550465SJed Brown   if (!FORTRANNULLBOOL(flg)) *flg = flag;
2039306f9a3SSatish Balay   FREECHAR(pre,c1);
2049306f9a3SSatish Balay   FREECHAR(name,c2);
2057c363081SBarry Smith   FIXRETURNCHAR(flag,string,len);
2069306f9a3SSatish Balay }
2079306f9a3SSatish Balay 
2089306f9a3SSatish Balay void PETSC_STDCALL petscgetprogramname_(CHAR name PETSC_MIXED_LEN(len_in),PetscErrorCode *ierr PETSC_END_LEN(len_in))
2099306f9a3SSatish Balay {
2109306f9a3SSatish Balay   char   *tmp;
2114610e317SSatish Balay   size_t len;
2129306f9a3SSatish Balay   tmp   = name;
2139306f9a3SSatish Balay   len   = len_in - 1;
2149306f9a3SSatish Balay   *ierr = PetscGetProgramName(tmp,len);
2157c363081SBarry Smith   FIXRETURNCHAR(PETSC_TRUE,name,len_in);
2169306f9a3SSatish Balay }
2179306f9a3SSatish Balay 
2183a15af8cSBlaise Bourdin void PETSC_STDCALL petscoptionsview_(PetscViewer *vin,PetscErrorCode *ierr)
2193a15af8cSBlaise Bourdin {
2203a15af8cSBlaise Bourdin   PetscViewer v;
2213a15af8cSBlaise Bourdin 
2223a15af8cSBlaise Bourdin   PetscPatchDefaultViewers_Fortran(vin,v);
2233a15af8cSBlaise Bourdin   *ierr = PetscOptionsView(v);
2243a15af8cSBlaise Bourdin }
2253a15af8cSBlaise Bourdin 
2269306f9a3SSatish Balay EXTERN_C_END
2279306f9a3SSatish Balay 
228