xref: /petsc/include/petscmath.h (revision 027d97944cda7b4c34840f81ea048835ceb0d704)
1e489efc1SBarry Smith /*
2314da920SBarry Smith 
3314da920SBarry Smith       PETSc mathematics include file. Defines certain basic mathematical
4a5057860SBarry Smith     constants and functions for working with single, double, and quad precision
5a5057860SBarry Smith     floating point numbers as well as complex single and double.
6314da920SBarry Smith 
7d382aafbSBarry Smith     This file is included by petscsys.h and should not be used directly.
8e7029fe1SSatish Balay 
9e489efc1SBarry Smith */
10e489efc1SBarry Smith 
11488ecbafSBarry Smith #if !defined(__PETSCMATH_H)
12488ecbafSBarry Smith #define __PETSCMATH_H
130a5f7794SBarry Smith #include <math.h>
140a5f7794SBarry Smith 
15314da920SBarry Smith /*
16f4ccad53SBarry Smith 
17f4ccad53SBarry Smith      Defines operations that are different for complex and real numbers;
18a5057860SBarry Smith    note that one cannot mix the use of complex and real in the same
19f4ccad53SBarry Smith    PETSc program. All PETSc objects in one program are built around the object
2098725619SBarry Smith    PetscScalar which is either always a real or a complex.
21f4ccad53SBarry Smith 
22e489efc1SBarry Smith */
23b36a9721SBarry Smith 
2459cb5930SBarry Smith #define PetscExpPassiveScalar(a) PetscExpScalar()
25c1d390e3SJed Brown #if defined(PETSC_USE_REAL_SINGLE)
26c1d390e3SJed Brown #define MPIU_REAL   MPI_FLOAT
27c1d390e3SJed Brown typedef float PetscReal;
289cf33046SSatish Balay #define PetscSqrtReal(a)    sqrt(a)
299a07f4dfSJed Brown #define PetscExpReal(a)     exp(a)
309a07f4dfSJed Brown #define PetscLogReal(a)     log(a)
3177b4d14cSPeter Brune #define PetscLog10Real(a)   log10(a)
3278a59e97SMatthew G. Knepley #ifdef PETSC_HAVE_LOG2
3378a59e97SMatthew G. Knepley #define PetscLog2Real(a)    log2(a)
3478a59e97SMatthew G. Knepley #endif
359a07f4dfSJed Brown #define PetscSinReal(a)     sin(a)
369a07f4dfSJed Brown #define PetscCosReal(a)     cos(a)
37a4bea5a6SPeter Brune #define PetscTanReal(a)     tan(a)
38255453a1SBarry Smith #define PetscAsinReal(a)    asin(a)
39255453a1SBarry Smith #define PetscAcosReal(a)    acos(a)
40a4bea5a6SPeter Brune #define PetscAtanReal(a)    atan(a)
411d5abddaSDmitry Karpeev #define PetscAtan2Real(a,b) atan2(a,b)
42a4bea5a6SPeter Brune #define PetscSinhReal(a)    sinh(a)
43a4bea5a6SPeter Brune #define PetscCoshReal(a)    cosh(a)
44a4bea5a6SPeter Brune #define PetscTanhReal(a)    tanh(a)
45369cc0aeSBarry Smith #define PetscPowReal(a,b)   pow(a,b)
4677b4d14cSPeter Brune #define PetscCeilReal(a)    ceil(a)
4777b4d14cSPeter Brune #define PetscFloorReal(a)   floor(a)
48a4bea5a6SPeter Brune #define PetscFmodReal(a,b)  fmod(a,b)
4943f0d3baSJed Brown #define PetscTGamma(a)      tgammaf(a)
50c1d390e3SJed Brown #elif defined(PETSC_USE_REAL_DOUBLE)
51c1d390e3SJed Brown #define MPIU_REAL   MPI_DOUBLE
52c1d390e3SJed Brown typedef double PetscReal;
538f1a2a5eSBarry Smith #define PetscSqrtReal(a)    sqrt(a)
549a07f4dfSJed Brown #define PetscExpReal(a)     exp(a)
559a07f4dfSJed Brown #define PetscLogReal(a)     log(a)
5677b4d14cSPeter Brune #define PetscLog10Real(a)   log10(a)
5778a59e97SMatthew G. Knepley #ifdef PETSC_HAVE_LOG2
5878a59e97SMatthew G. Knepley #define PetscLog2Real(a)    log2(a)
5978a59e97SMatthew G. Knepley #endif
609a07f4dfSJed Brown #define PetscSinReal(a)     sin(a)
619a07f4dfSJed Brown #define PetscCosReal(a)     cos(a)
62a4bea5a6SPeter Brune #define PetscTanReal(a)     tan(a)
63255453a1SBarry Smith #define PetscAsinReal(a)    asin(a)
64255453a1SBarry Smith #define PetscAcosReal(a)    acos(a)
65a4bea5a6SPeter Brune #define PetscAtanReal(a)    atan(a)
661d5abddaSDmitry Karpeev #define PetscAtan2Real(a,b) atan2(a,b)
678d1b9be0SJed Brown #define PetscSinhReal(a)    sinh(a)
688d1b9be0SJed Brown #define PetscCoshReal(a)    cosh(a)
698d1b9be0SJed Brown #define PetscTanhReal(a)    tanh(a)
70369cc0aeSBarry Smith #define PetscPowReal(a,b)   pow(a,b)
7177b4d14cSPeter Brune #define PetscCeilReal(a)    ceil(a)
7277b4d14cSPeter Brune #define PetscFloorReal(a)   floor(a)
73a4bea5a6SPeter Brune #define PetscFmodReal(a,b)  fmod(a,b)
740646a658SBarry Smith #define PetscTGamma(a)      tgamma(a)
75c1d390e3SJed Brown #elif defined(PETSC_USE_REAL___FLOAT128)
76574fde7bSSatish Balay #if defined(__cplusplus)
77574fde7bSSatish Balay extern "C" {
78574fde7bSSatish Balay #endif
79574fde7bSSatish Balay #include <quadmath.h>
80574fde7bSSatish Balay #if defined(__cplusplus)
81574fde7bSSatish Balay }
82574fde7bSSatish Balay #endif
838ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU___FLOAT128 PetscAttrMPITypeTag(__float128);
84c1d390e3SJed Brown #define MPIU_REAL MPIU___FLOAT128
85c1d390e3SJed Brown typedef __float128 PetscReal;
868f1a2a5eSBarry Smith #define PetscSqrtReal(a)    sqrtq(a)
879a07f4dfSJed Brown #define PetscExpReal(a)     expq(a)
889a07f4dfSJed Brown #define PetscLogReal(a)     logq(a)
8977b4d14cSPeter Brune #define PetscLog10Real(a)   log10q(a)
9078a59e97SMatthew G. Knepley #ifdef PETSC_HAVE_LOG2
9178a59e97SMatthew G. Knepley #define PetscLog2Real(a)    log2q(a)
9278a59e97SMatthew G. Knepley #endif
939a07f4dfSJed Brown #define PetscSinReal(a)     sinq(a)
949a07f4dfSJed Brown #define PetscCosReal(a)     cosq(a)
95a4bea5a6SPeter Brune #define PetscTanReal(a)     tanq(a)
96255453a1SBarry Smith #define PetscAsinReal(a)    asinq(a)
97255453a1SBarry Smith #define PetscAcosReal(a)    acosq(a)
98a4bea5a6SPeter Brune #define PetscAtanReal(a)    atanq(a)
991d5abddaSDmitry Karpeev #define PetscAtan2Real(a,b) atan2q(a,b)
1008d1b9be0SJed Brown #define PetscSinhReal(a)    sinhq(a)
1018d1b9be0SJed Brown #define PetscCoshReal(a)    coshq(a)
1028d1b9be0SJed Brown #define PetscTanhReal(a)    tanhq(a)
103369cc0aeSBarry Smith #define PetscPowReal(a,b)   powq(a,b)
10477b4d14cSPeter Brune #define PetscCeilReal(a)    ceilq(a)
10577b4d14cSPeter Brune #define PetscFloorReal(a)   floorq(a)
106a4bea5a6SPeter Brune #define PetscFmodReal(a,b)  fmodq(a,b)
1070646a658SBarry Smith #define PetscTGamma(a)      tgammaq(a)
108c1d390e3SJed Brown #endif /* PETSC_USE_REAL_* */
10959cb5930SBarry Smith 
1101093a601SBarry Smith /*
1111093a601SBarry Smith     Complex number definitions
1121093a601SBarry Smith  */
1132f217381SBarry Smith #if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX) && !defined(PETSC_USE_REAL___FLOAT128)
1148cd53115SBarry Smith #if !defined(PETSC_SKIP_COMPLEX)
11550f81f78SJed Brown #define PETSC_HAVE_COMPLEX 1
1161093a601SBarry Smith /* C++ support of complex number */
117debe9ee2SPaul Mullowney #if defined(PETSC_HAVE_CUSP)
118debe9ee2SPaul Mullowney #define complexlib cusp
1199ae82921SPaul Mullowney #include <cusp/complex.h>
120debe9ee2SPaul Mullowney #else
121debe9ee2SPaul Mullowney #define complexlib std
122debe9ee2SPaul Mullowney #include <complex>
1239ae82921SPaul Mullowney #endif
124b7940d39SSatish Balay 
12550f81f78SJed Brown #define PetscRealPartComplex(a)      (a).real()
12650f81f78SJed Brown #define PetscImaginaryPartComplex(a) (a).imag()
12750f81f78SJed Brown #define PetscAbsComplex(a)           complexlib::abs(a)
12850f81f78SJed Brown #define PetscConjComplex(a)          complexlib::conj(a)
12950f81f78SJed Brown #define PetscSqrtComplex(a)          complexlib::sqrt(a)
13050f81f78SJed Brown #define PetscPowComplex(a,b)         complexlib::pow(a,b)
13150f81f78SJed Brown #define PetscExpComplex(a)           complexlib::exp(a)
13250f81f78SJed Brown #define PetscLogComplex(a)           complexlib::log(a)
13350f81f78SJed Brown #define PetscSinComplex(a)           complexlib::sin(a)
13450f81f78SJed Brown #define PetscCosComplex(a)           complexlib::cos(a)
135255453a1SBarry Smith #define PetscAsinComplex(a)          complexlib::asin(a)
136255453a1SBarry Smith #define PetscAcosComplex(a)          complexlib::acos(a)
137*027d9794SBarry Smith #if defined(PETSC_HAVE_TANCOMPLEX)
138a4bea5a6SPeter Brune #define PetscTanComplex(a)           complexlib::tan(a)
139*027d9794SBarry Smith #else
140*027d9794SBarry Smith #define PetscTanComplex(a)           PetscSinComplex(a)/PetscCosComplex(a)
141*027d9794SBarry Smith #endif
142a4bea5a6SPeter Brune #define PetscSinhComplex(a)          complexlib::sinh(a)
143a4bea5a6SPeter Brune #define PetscCoshComplex(a)          complexlib::cosh(a)
144*027d9794SBarry Smith #if defined(PETSC_HAVE_TANHCOMPLEX)
145a4bea5a6SPeter Brune #define PetscTanhComplex(a)          complexlib::tanh(a)
146*027d9794SBarry Smith #else
147*027d9794SBarry Smith #define PetscTanhComplex(a)          PetscSinhComplex(a)/PetscCoshComplex(a)
148*027d9794SBarry Smith #endif
149debe9ee2SPaul Mullowney 
150debe9ee2SPaul Mullowney #if defined(PETSC_USE_REAL_SINGLE)
15150f81f78SJed Brown typedef complexlib::complex<float> PetscComplex;
152debe9ee2SPaul Mullowney #elif defined(PETSC_USE_REAL_DOUBLE)
15350f81f78SJed Brown typedef complexlib::complex<double> PetscComplex;
1548c764dc5SJose Roman #elif defined(PETSC_USE_REAL___FLOAT128)
15550f81f78SJed Brown typedef complexlib::complex<__float128> PetscComplex; /* Notstandard and not expected to work, use __complex128 */
15622b3908eSBarry Smith PETSC_EXTERN MPI_Datatype MPIU___COMPLEX128;
157debe9ee2SPaul Mullowney #endif  /* PETSC_USE_REAL_ */
1588cd53115SBarry Smith #endif  /* ! PETSC_SKIP_COMPLEX */
159debe9ee2SPaul Mullowney 
1602f217381SBarry Smith #elif !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX)
1618cd53115SBarry Smith #if !defined(PETSC_SKIP_COMPLEX)
1629f20b660SSatish Balay #define PETSC_HAVE_COMPLEX 1
163519e2a1fSPaul Mullowney #include <complex.h>
164519e2a1fSPaul Mullowney 
165ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
16650f81f78SJed Brown typedef float _Complex PetscComplex;
16785b47369SMatthew Knepley 
16850f81f78SJed Brown #define PetscRealPartComplex(a)      crealf(a)
16950f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimagf(a)
17050f81f78SJed Brown #define PetscAbsComplex(a)           cabsf(a)
17150f81f78SJed Brown #define PetscConjComplex(a)          conjf(a)
17250f81f78SJed Brown #define PetscSqrtComplex(a)          csqrtf(a)
17350f81f78SJed Brown #define PetscPowComplex(a,b)         cpowf(a,b)
17450f81f78SJed Brown #define PetscExpComplex(a)           cexpf(a)
17550f81f78SJed Brown #define PetscLogComplex(a)           clogf(a)
17650f81f78SJed Brown #define PetscSinComplex(a)           csinf(a)
17750f81f78SJed Brown #define PetscCosComplex(a)           ccosf(a)
178255453a1SBarry Smith #define PetscAsinComplex(a)          casinf(a)
179255453a1SBarry Smith #define PetscAcosComplex(a)          cacosf(a)
180a4bea5a6SPeter Brune #define PetscTanComplex(a)           ctanf(a)
181a4bea5a6SPeter Brune #define PetscSinhComplex(a)          csinhf(a)
182a4bea5a6SPeter Brune #define PetscCoshComplex(a)          ccoshf(a)
183a4bea5a6SPeter Brune #define PetscTanhComplex(a)          ctanhf(a)
1841093a601SBarry Smith 
185ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_DOUBLE)
18650f81f78SJed Brown typedef double _Complex PetscComplex;
1871093a601SBarry Smith 
18850f81f78SJed Brown #define PetscRealPartComplex(a)      creal(a)
18950f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimag(a)
19050f81f78SJed Brown #define PetscAbsComplex(a)           cabs(a)
19150f81f78SJed Brown #define PetscConjComplex(a)          conj(a)
19250f81f78SJed Brown #define PetscSqrtComplex(a)          csqrt(a)
19350f81f78SJed Brown #define PetscPowComplex(a,b)         cpow(a,b)
19450f81f78SJed Brown #define PetscExpComplex(a)           cexp(a)
19550f81f78SJed Brown #define PetscLogComplex(a)           clog(a)
19650f81f78SJed Brown #define PetscSinComplex(a)           csin(a)
19750f81f78SJed Brown #define PetscCosComplex(a)           ccos(a)
198255453a1SBarry Smith #define PetscAsinComplex(a)          casin(a)
199255453a1SBarry Smith #define PetscAcosComplex(a)          cacos(a)
200a4bea5a6SPeter Brune #define PetscTanComplex(a)           ctan(a)
201a4bea5a6SPeter Brune #define PetscSinhComplex(a)          csinh(a)
202a4bea5a6SPeter Brune #define PetscCoshComplex(a)          ccosh(a)
203a4bea5a6SPeter Brune #define PetscTanhComplex(a)          ctanh(a)
2041093a601SBarry Smith 
2058c764dc5SJose Roman #elif defined(PETSC_USE_REAL___FLOAT128)
20650f81f78SJed Brown typedef __complex128 PetscComplex;
2078ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU___COMPLEX128 PetscAttrMPITypeTag(__complex128);
2088c764dc5SJose Roman 
20950f81f78SJed Brown #define PetscRealPartComplex(a)      crealq(a)
21050f81f78SJed Brown #define PetscImaginaryPartComplex(a) cimagq(a)
21150f81f78SJed Brown #define PetscAbsComplex(a)           cabsq(a)
21250f81f78SJed Brown #define PetscConjComplex(a)          conjq(a)
21350f81f78SJed Brown #define PetscSqrtComplex(a)          csqrtq(a)
21450f81f78SJed Brown #define PetscPowComplex(a,b)         cpowq(a,b)
21550f81f78SJed Brown #define PetscExpComplex(a)           cexpq(a)
21650f81f78SJed Brown #define PetscLogComplex(a)           clogq(a)
21750f81f78SJed Brown #define PetscSinComplex(a)           csinq(a)
21850f81f78SJed Brown #define PetscCosComplex(a)           ccosq(a)
219255453a1SBarry Smith #define PetscAsinComplex(a)          casinq(a)
220255453a1SBarry Smith #define PetscAcosComplex(a)          cacosq(a)
221a4bea5a6SPeter Brune #define PetscTanComplex(a)           ctanq(a)
222a4bea5a6SPeter Brune #define PetscSinhComplex(a)          csinhq(a)
223a4bea5a6SPeter Brune #define PetscCoshComplex(a)          ccoshq(a)
224a4bea5a6SPeter Brune #define PetscTanhComplex(a)          ctanhq(a)
225a4bea5a6SPeter Brune 
226ce63c4c1SBarry Smith #endif /* PETSC_USE_REAL_* */
227d4161b4aSBarry Smith #elif (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX))
22850f81f78SJed Brown #error "PETSc was configured --with-scalar-type=complex, but a language-appropriate complex library is not available"
2298cd53115SBarry Smith #endif /* !PETSC_SKIP_COMPLEX */
2302f217381SBarry Smith #endif /* (__cplusplus && PETSC_HAVE_CXX_COMPLEX) else-if (!__cplusplus && PETSC_HAVE_C99_COMPLEX) */
231e489efc1SBarry Smith 
2328dc6f2c2SJed Brown #if defined(PETSC_HAVE_COMPLEX)
23370da9c3bSJed Brown #if defined(PETSC_HAVE_MPI_C_DOUBLE_COMPLEX)
234500d8756SSatish Balay #define MPIU_C_DOUBLE_COMPLEX MPI_C_DOUBLE_COMPLEX
235500d8756SSatish Balay #define MPIU_C_COMPLEX MPI_C_COMPLEX
23670da9c3bSJed Brown #else
2372f217381SBarry Smith # if defined(__cplusplus) && defined(PETSC_HAVE_CXX_COMPLEX)
2388ad47952SJed Brown   typedef complexlib::complex<double> petsc_mpiu_c_double_complex;
2398ad47952SJed Brown   typedef complexlib::complex<float> petsc_mpiu_c_complex;
2402f217381SBarry Smith # elif !defined(__cplusplus) && defined(PETSC_HAVE_C99_COMPLEX)
2418ad47952SJed Brown   typedef double _Complex petsc_mpiu_c_double_complex;
2428ad47952SJed Brown   typedef float _Complex petsc_mpiu_c_complex;
2438ad47952SJed Brown # else
2448ad47952SJed Brown   typedef struct {double real,imag;} petsc_mpiu_c_double_complex;
2458ad47952SJed Brown   typedef struct {float real,imag;} petsc_mpiu_c_complex;
2468ad47952SJed Brown # endif
2478ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_C_DOUBLE_COMPLEX PetscAttrMPITypeTagLayoutCompatible(petsc_mpiu_c_double_complex);
2488ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_C_COMPLEX PetscAttrMPITypeTagLayoutCompatible(petsc_mpiu_c_complex);
2491b65fc54SMatthew G Knepley #endif /* PETSC_HAVE_MPI_C_DOUBLE_COMPLEX */
2508dc6f2c2SJed Brown #endif /* PETSC_HAVE_COMPLEX */
2512c876bd9SBarry Smith 
2527c2de775SJed Brown #if defined(PETSC_HAVE_COMPLEX)
2537c2de775SJed Brown #  if defined(PETSC_USE_REAL_SINGLE)
2547c2de775SJed Brown #    define MPIU_COMPLEX MPIU_C_COMPLEX
2557c2de775SJed Brown #  elif defined(PETSC_USE_REAL_DOUBLE)
2567c2de775SJed Brown #    define MPIU_COMPLEX MPIU_C_DOUBLE_COMPLEX
2577c2de775SJed Brown #  elif defined(PETSC_USE_REAL___FLOAT128)
2587c2de775SJed Brown #    define MPIU_COMPLEX MPIU___COMPLEX128
2597c2de775SJed Brown #  endif /* PETSC_USE_REAL_* */
2607c2de775SJed Brown #endif
2617c2de775SJed Brown 
262d4161b4aSBarry Smith #if (defined(PETSC_USE_COMPLEX) && !defined(PETSC_SKIP_COMPLEX))
26350f81f78SJed Brown typedef PetscComplex PetscScalar;
26450f81f78SJed Brown #define PetscRealPart(a)      PetscRealPartComplex(a)
26550f81f78SJed Brown #define PetscImaginaryPart(a) PetscImaginaryPartComplex(a)
26650f81f78SJed Brown #define PetscAbsScalar(a)     PetscAbsComplex(a)
26750f81f78SJed Brown #define PetscConj(a)          PetscConjComplex(a)
26850f81f78SJed Brown #define PetscSqrtScalar(a)    PetscSqrtComplex(a)
26950f81f78SJed Brown #define PetscPowScalar(a,b)   PetscPowComplex(a,b)
27050f81f78SJed Brown #define PetscExpScalar(a)     PetscExpComplex(a)
27150f81f78SJed Brown #define PetscLogScalar(a)     PetscLogComplex(a)
27250f81f78SJed Brown #define PetscSinScalar(a)     PetscSinComplex(a)
27350f81f78SJed Brown #define PetscCosScalar(a)     PetscCosComplex(a)
274255453a1SBarry Smith #define PetscAsinScalar(a)    PetscAsinComplex(a)
275255453a1SBarry Smith #define PetscAcosScalar(a)    PetscAcosComplex(a)
276a4bea5a6SPeter Brune #define PetscTanScalar(a)     PetscTanComplex(a)
277a4bea5a6SPeter Brune #define PetscSinhScalar(a)    PetscSinhComplex(a)
278a4bea5a6SPeter Brune #define PetscCoshScalar(a)    PetscCoshComplex(a)
279a4bea5a6SPeter Brune #define PetscTanhScalar(a)    PetscTanhComplex(a)
2807c2de775SJed Brown #define MPIU_SCALAR MPIU_COMPLEX
28175567043SBarry Smith 
2821093a601SBarry Smith /*
2831093a601SBarry Smith     real number definitions
2841093a601SBarry Smith  */
2851b65fc54SMatthew G Knepley #else /* PETSC_USE_COMPLEX */
2867c2de775SJed Brown typedef PetscReal PetscScalar;
2877c2de775SJed Brown #define MPIU_SCALAR MPIU_REAL
2887c2de775SJed Brown 
289329f5518SBarry Smith #define PetscRealPart(a)      (a)
290c1d390e3SJed Brown #define PetscImaginaryPart(a) ((PetscReal)0.)
291c1d390e3SJed Brown PETSC_STATIC_INLINE PetscReal PetscAbsScalar(PetscScalar a) {return a < 0.0 ? -a : a;}
292e489efc1SBarry Smith #define PetscConj(a)          (a)
293ce63c4c1SBarry Smith #if !defined(PETSC_USE_REAL___FLOAT128)
29418a7d68fSSatish Balay #define PetscSqrtScalar(a)    sqrt(a)
295184914b5SBarry Smith #define PetscPowScalar(a,b)   pow(a,b)
296184914b5SBarry Smith #define PetscExpScalar(a)     exp(a)
29706c1185fSBarry Smith #define PetscLogScalar(a)     log(a)
298184914b5SBarry Smith #define PetscSinScalar(a)     sin(a)
299184914b5SBarry Smith #define PetscCosScalar(a)     cos(a)
300255453a1SBarry Smith #define PetscAsinScalar(a)    asin(a)
301255453a1SBarry Smith #define PetscAcosScalar(a)    acos(a)
302a4bea5a6SPeter Brune #define PetscTanScalar(a)     tan(a)
303a4bea5a6SPeter Brune #define PetscSinhScalar(a)    sinh(a)
304a4bea5a6SPeter Brune #define PetscCoshScalar(a)    cosh(a)
305a4bea5a6SPeter Brune #define PetscTanhScalar(a)    tanh(a)
306ce63c4c1SBarry Smith #else /* PETSC_USE_REAL___FLOAT128 */
3070d0cc1b5SBarry Smith #define PetscSqrtScalar(a)    sqrtq(a)
3080d0cc1b5SBarry Smith #define PetscPowScalar(a,b)   powq(a,b)
3090d0cc1b5SBarry Smith #define PetscExpScalar(a)     expq(a)
3100d0cc1b5SBarry Smith #define PetscLogScalar(a)     logq(a)
3110d0cc1b5SBarry Smith #define PetscSinScalar(a)     sinq(a)
3120d0cc1b5SBarry Smith #define PetscCosScalar(a)     cosq(a)
313255453a1SBarry Smith #define PetscAsinScalar(a)    asinq(a)
314255453a1SBarry Smith #define PetscAcosScalar(a)    acosq(a)
315a4bea5a6SPeter Brune #define PetscTanScalar(a)     tanq(a)
316a4bea5a6SPeter Brune #define PetscSinhScalar(a)    sinhq(a)
317a4bea5a6SPeter Brune #define PetscCoshScalar(a)    coshq(a)
318a4bea5a6SPeter Brune #define PetscTanhScalar(a)    tanhq(a)
319ce63c4c1SBarry Smith #endif /* PETSC_USE_REAL___FLOAT128 */
320b0a32e0cSBarry Smith 
3211b65fc54SMatthew G Knepley #endif /* PETSC_USE_COMPLEX */
322e489efc1SBarry Smith 
323da9b6338SBarry Smith #define PetscSign(a) (((a) >= 0) ? ((a) == 0 ? 0 : 1) : -1)
32426aa1773SMatthew Knepley #define PetscAbs(a)  (((a) >= 0) ? (a) : -(a))
3253f1db9ecSBarry Smith 
326314da920SBarry Smith /* --------------------------------------------------------------------------*/
327314da920SBarry Smith 
328e489efc1SBarry Smith /*
329f22f69f0SBarry Smith    Certain objects may be created using either single or double precision.
330f22f69f0SBarry Smith    This is currently not used.
331e489efc1SBarry Smith */
332557d4da8SBarry Smith typedef enum { PETSC_SCALAR_DOUBLE,PETSC_SCALAR_SINGLE, PETSC_SCALAR_LONG_DOUBLE } PetscScalarPrecision;
333e489efc1SBarry Smith 
33450f81f78SJed Brown #if defined(PETSC_HAVE_COMPLEX)
335e489efc1SBarry Smith /* PETSC_i is the imaginary number, i */
33650f81f78SJed Brown PETSC_EXTERN PetscComplex PETSC_i;
33750f81f78SJed Brown #endif
338e489efc1SBarry Smith 
339b6a5bde7SBarry Smith /*MC
340b6a5bde7SBarry Smith    PetscMin - Returns minimum of two numbers
341b6a5bde7SBarry Smith 
342eca87e8dSBarry Smith    Synopsis:
343aaa7dc30SBarry Smith    #include <petscmath.h>
344eca87e8dSBarry Smith    type PetscMin(type v1,type v2)
345eca87e8dSBarry Smith 
346eca87e8dSBarry Smith    Not Collective
347eca87e8dSBarry Smith 
348b6a5bde7SBarry Smith    Input Parameter:
349b6a5bde7SBarry Smith +  v1 - first value to find minimum of
350b6a5bde7SBarry Smith -  v2 - second value to find minimum of
351b6a5bde7SBarry Smith 
352b6a5bde7SBarry Smith    Notes: type can be integer or floating point value
353b6a5bde7SBarry Smith 
354b6a5bde7SBarry Smith    Level: beginner
355b6a5bde7SBarry Smith 
356d9a4bb16SJed Brown .seealso: PetscMin(), PetscClipInterval(), PetscAbsInt(), PetscAbsReal(), PetscSqr()
357b6a5bde7SBarry Smith 
358b6a5bde7SBarry Smith M*/
359e489efc1SBarry Smith #define PetscMin(a,b)   (((a)<(b)) ?  (a) : (b))
360b6a5bde7SBarry Smith 
361b6a5bde7SBarry Smith /*MC
362b6a5bde7SBarry Smith    PetscMax - Returns maxium of two numbers
363b6a5bde7SBarry Smith 
364eca87e8dSBarry Smith    Synopsis:
365aaa7dc30SBarry Smith    #include <petscmath.h>
366eca87e8dSBarry Smith    type max PetscMax(type v1,type v2)
367eca87e8dSBarry Smith 
368eca87e8dSBarry Smith    Not Collective
369eca87e8dSBarry Smith 
370b6a5bde7SBarry Smith    Input Parameter:
371b6a5bde7SBarry Smith +  v1 - first value to find maximum of
372b6a5bde7SBarry Smith -  v2 - second value to find maximum of
373b6a5bde7SBarry Smith 
374b6a5bde7SBarry Smith    Notes: type can be integer or floating point value
375b6a5bde7SBarry Smith 
376b6a5bde7SBarry Smith    Level: beginner
377b6a5bde7SBarry Smith 
378d9a4bb16SJed Brown .seealso: PetscMin(), PetscClipInterval(), PetscAbsInt(), PetscAbsReal(), PetscSqr()
379b6a5bde7SBarry Smith 
380b6a5bde7SBarry Smith M*/
381e489efc1SBarry Smith #define PetscMax(a,b)   (((a)<(b)) ?  (b) : (a))
382b6a5bde7SBarry Smith 
383b6a5bde7SBarry Smith /*MC
384d9a4bb16SJed Brown    PetscClipInterval - Returns a number clipped to be within an interval
385d9a4bb16SJed Brown 
386d9a4bb16SJed Brown    Synopsis:
387aaa7dc30SBarry Smith    #include <petscmath.h>
388d9a4bb16SJed Brown    type clip PetscClipInterval(type x,type a,type b)
389d9a4bb16SJed Brown 
390d9a4bb16SJed Brown    Not Collective
391d9a4bb16SJed Brown 
392d9a4bb16SJed Brown    Input Parameter:
393d9a4bb16SJed Brown +  x - value to use if within interval (a,b)
394d9a4bb16SJed Brown .  a - lower end of interval
395d9a4bb16SJed Brown -  b - upper end of interval
396d9a4bb16SJed Brown 
397d9a4bb16SJed Brown    Notes: type can be integer or floating point value
398d9a4bb16SJed Brown 
399d9a4bb16SJed Brown    Level: beginner
400d9a4bb16SJed Brown 
401d9a4bb16SJed Brown .seealso: PetscMin(), PetscMax(), PetscAbsInt(), PetscAbsReal(), PetscSqr()
402d9a4bb16SJed Brown 
403d9a4bb16SJed Brown M*/
404d9a4bb16SJed Brown #define PetscClipInterval(x,a,b)   (PetscMax((a),PetscMin((x),(b))))
405d9a4bb16SJed Brown 
406d9a4bb16SJed Brown /*MC
407b6a5bde7SBarry Smith    PetscAbsInt - Returns the absolute value of an integer
408b6a5bde7SBarry Smith 
409b6a5bde7SBarry Smith    Synopsis:
410aaa7dc30SBarry Smith    #include <petscmath.h>
411b6a5bde7SBarry Smith    int abs PetscAbsInt(int v1)
412b6a5bde7SBarry Smith 
413eca87e8dSBarry Smith    Not Collective
414eca87e8dSBarry Smith 
415eca87e8dSBarry Smith    Input Parameter:
416eca87e8dSBarry Smith .   v1 - the integer
417b6a5bde7SBarry Smith 
418b6a5bde7SBarry Smith    Level: beginner
419b6a5bde7SBarry Smith 
420b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsReal(), PetscSqr()
421b6a5bde7SBarry Smith 
422b6a5bde7SBarry Smith M*/
423e489efc1SBarry Smith #define PetscAbsInt(a)  (((a)<0)   ? -(a) : (a))
424b6a5bde7SBarry Smith 
425b6a5bde7SBarry Smith /*MC
426b6a5bde7SBarry Smith    PetscAbsReal - Returns the absolute value of an real number
427b6a5bde7SBarry Smith 
428eca87e8dSBarry Smith    Synopsis:
429aaa7dc30SBarry Smith    #include <petscmath.h>
430eca87e8dSBarry Smith    Real abs PetscAbsReal(PetscReal v1)
431eca87e8dSBarry Smith 
432eca87e8dSBarry Smith    Not Collective
433eca87e8dSBarry Smith 
434b6a5bde7SBarry Smith    Input Parameter:
435b6a5bde7SBarry Smith .   v1 - the double
436b6a5bde7SBarry Smith 
437b6a5bde7SBarry Smith 
438b6a5bde7SBarry Smith    Level: beginner
439b6a5bde7SBarry Smith 
440b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsInt(), PetscSqr()
441b6a5bde7SBarry Smith 
442b6a5bde7SBarry Smith M*/
443f6275e2eSBarry Smith #define PetscAbsReal(a) (((a)<0)   ? -(a) : (a))
444b6a5bde7SBarry Smith 
445b6a5bde7SBarry Smith /*MC
446b6a5bde7SBarry Smith    PetscSqr - Returns the square of a number
447b6a5bde7SBarry Smith 
448b6a5bde7SBarry Smith    Synopsis:
449aaa7dc30SBarry Smith    #include <petscmath.h>
450b6a5bde7SBarry Smith    type sqr PetscSqr(type v1)
451b6a5bde7SBarry Smith 
452eca87e8dSBarry Smith    Not Collective
453eca87e8dSBarry Smith 
454eca87e8dSBarry Smith    Input Parameter:
455eca87e8dSBarry Smith .   v1 - the value
456eca87e8dSBarry Smith 
457b6a5bde7SBarry Smith    Notes: type can be integer or floating point value
458b6a5bde7SBarry Smith 
459b6a5bde7SBarry Smith    Level: beginner
460b6a5bde7SBarry Smith 
461b6a5bde7SBarry Smith .seealso: PetscMax(), PetscMin(), PetscAbsInt(), PetscAbsReal()
462b6a5bde7SBarry Smith 
463b6a5bde7SBarry Smith M*/
4644ebda54eSMatthew Knepley #define PetscSqr(a)     ((a)*(a))
465e489efc1SBarry Smith 
466314da920SBarry Smith /* ----------------------------------------------------------------------------*/
467314da920SBarry Smith /*
468d34fcf5fSBarry Smith      Basic constants
469314da920SBarry Smith */
470ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
471d34fcf5fSBarry Smith #define PETSC_PI                 M_PIq
472d34fcf5fSBarry Smith #elif defined(M_PI)
473d34fcf5fSBarry Smith #define PETSC_PI                 M_PI
474d34fcf5fSBarry Smith #else
475faa6e9b0SMatthew G Knepley #define PETSC_PI                 3.14159265358979323846264338327950288419716939937510582
476d34fcf5fSBarry Smith #endif
477d34fcf5fSBarry Smith 
478ab824b78SBarry Smith #if !defined(PETSC_USE_64BIT_INDICES)
47971fd2e92SBarry Smith #define PETSC_MAX_INT            2147483647
480ab824b78SBarry Smith #define PETSC_MIN_INT            (-PETSC_MAX_INT - 1)
481ab824b78SBarry Smith #else
482ab824b78SBarry Smith #define PETSC_MAX_INT            9223372036854775807L
483ab824b78SBarry Smith #define PETSC_MIN_INT            (-PETSC_MAX_INT - 1)
484ab824b78SBarry Smith #endif
485e489efc1SBarry Smith 
486ce63c4c1SBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
487ab824b78SBarry Smith #  define PETSC_MAX_REAL                3.40282346638528860e+38F
488ea345e14SBarry Smith #  define PETSC_MIN_REAL                -PETSC_MAX_REAL
48982a7e548SBarry Smith #  define PETSC_MACHINE_EPSILON         1.19209290e-07F
49082a7e548SBarry Smith #  define PETSC_SQRT_MACHINE_EPSILON    3.45266983e-04F
491cf6e855fSSatish Balay #  define PETSC_SMALL                   1.e-5
492ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL_DOUBLE)
493ab824b78SBarry Smith #  define PETSC_MAX_REAL                1.7976931348623157e+308
494ea345e14SBarry Smith #  define PETSC_MIN_REAL                -PETSC_MAX_REAL
49582a7e548SBarry Smith #  define PETSC_MACHINE_EPSILON         2.2204460492503131e-16
49682a7e548SBarry Smith #  define PETSC_SQRT_MACHINE_EPSILON    1.490116119384766e-08
497cf6e855fSSatish Balay #  define PETSC_SMALL                   1.e-10
498ce63c4c1SBarry Smith #elif defined(PETSC_USE_REAL___FLOAT128)
499ea345e14SBarry Smith #  define PETSC_MAX_REAL                FLT128_MAX
500ce63c4c1SBarry Smith #  define PETSC_MIN_REAL                -FLT128_MAX
501d34fcf5fSBarry Smith #  define PETSC_MACHINE_EPSILON         FLT128_EPSILON
50246d881e9SBarry Smith #  define PETSC_SQRT_MACHINE_EPSILON    1.38777878078e-17q
50346d881e9SBarry Smith #  define PETSC_SMALL                   1.e-20q
5049cf09972SJed Brown #endif
5053e523bebSBarry Smith 
506e270355aSBarry Smith #define PETSC_INFINITY                PETSC_MAX_REAL/4.0
507e270355aSBarry Smith #define PETSC_NINFINITY              -PETSC_INFINITY
508e270355aSBarry Smith 
509014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscIsInfOrNanReal(PetscReal);
510bae46576SBarry Smith PETSC_EXTERN PetscErrorCode PetscIsNanReal(PetscReal);
5118b49ba18SBarry Smith PETSC_EXTERN PetscBool PetscIsNormalReal(PetscReal);
512834b1445SSatish Balay PETSC_STATIC_INLINE PetscErrorCode PetscIsInfOrNanScalar(PetscScalar v) {return PetscIsInfOrNanReal(PetscAbsScalar(v));}
513bae46576SBarry Smith PETSC_STATIC_INLINE PetscErrorCode PetscIsNanScalar(PetscScalar v) {return PetscIsNanReal(PetscAbsScalar(v));}
514834b1445SSatish Balay PETSC_STATIC_INLINE PetscErrorCode PetscIsNormalScalar(PetscScalar v) {return PetscIsNormalReal(PetscAbsScalar(v));}
5159a25a3ccSBarry Smith 
516314da920SBarry Smith /* ----------------------------------------------------------------------------*/
51787828ca2SBarry Smith #define PassiveReal   PetscReal
518ea709b57SSatish Balay #define PassiveScalar PetscScalar
519d3ecb3a7SBarry Smith 
52098725619SBarry Smith /*
52198725619SBarry Smith     These macros are currently hardwired to match the regular data types, so there is no support for a different
52298725619SBarry Smith     MatScalar from PetscScalar. We left the MatScalar in the source just in case we use it again.
52398725619SBarry Smith  */
52498725619SBarry Smith #define MPIU_MATSCALAR MPIU_SCALAR
52598725619SBarry Smith typedef PetscScalar MatScalar;
52698725619SBarry Smith typedef PetscReal MatReal;
52798725619SBarry Smith 
5288ad47952SJed Brown struct petsc_mpiu_2scalar {PetscScalar a,b;};
5298ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_2SCALAR PetscAttrMPITypeTagLayoutCompatible(struct petsc_mpiu_2scalar);
5308ad47952SJed Brown #if defined(PETSC_USE_64BIT_INDICES) || !defined(MPI_2INT)
5318ad47952SJed Brown struct petsc_mpiu_2int {PetscInt a,b;};
5328ad47952SJed Brown PETSC_EXTERN MPI_Datatype MPIU_2INT PetscAttrMPITypeTagLayoutCompatible(struct petsc_mpiu_2int);
5338ad47952SJed Brown #else
5348ad47952SJed Brown #define MPIU_2INT MPI_2INT
5358ad47952SJed Brown #endif
536e9fa29b7SSatish Balay 
537b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscInt PetscPowInt(PetscInt base,PetscInt power)
538b2fb0278SBarry Smith {
539fa711258SJed Brown   PetscInt result = 1;
540fa711258SJed Brown   while (power) {
541fa711258SJed Brown     if (power & 1) result *= base;
542fa711258SJed Brown     power >>= 1;
543fa711258SJed Brown     base *= base;
544fa711258SJed Brown   }
545fa711258SJed Brown   return result;
546fa711258SJed Brown }
547b2fb0278SBarry Smith 
548b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscReal PetscPowRealInt(PetscReal base,PetscInt power)
549b2fb0278SBarry Smith {
550fa711258SJed Brown   PetscReal result = 1;
551d98d5da7SBarry Smith   if (power < 0) {
552d98d5da7SBarry Smith     power = -power;
55379674b66SBarry Smith     if (base != (PetscReal)0.0) base  = ((PetscReal)1.)/base;
554d98d5da7SBarry Smith   }
555fa711258SJed Brown   while (power) {
556fa711258SJed Brown     if (power & 1) result *= base;
557fa711258SJed Brown     power >>= 1;
558fa711258SJed Brown     base *= base;
559fa711258SJed Brown   }
560fa711258SJed Brown   return result;
561fa711258SJed Brown }
562fa711258SJed Brown 
563b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscScalar PetscPowScalarInt(PetscScalar base,PetscInt power)
564b2fb0278SBarry Smith {
5658b49ba18SBarry Smith   PetscScalar result = 1;
5668b49ba18SBarry Smith   if (power < 0) {
5678b49ba18SBarry Smith     power = -power;
568b103e46eSBarry Smith     if (base != (PetscScalar)0.0) base  = ((PetscScalar)1.)/base;
5698b49ba18SBarry Smith   }
5708b49ba18SBarry Smith   while (power) {
5718b49ba18SBarry Smith     if (power & 1) result *= base;
5728b49ba18SBarry Smith     power >>= 1;
5738b49ba18SBarry Smith     base *= base;
5748b49ba18SBarry Smith   }
5758b49ba18SBarry Smith   return result;
5768b49ba18SBarry Smith }
5778b49ba18SBarry Smith 
578b2fb0278SBarry Smith PETSC_STATIC_INLINE PetscScalar PetscPowScalarReal(PetscScalar base,PetscReal power)
579b2fb0278SBarry Smith {
580b2fb0278SBarry Smith   PetscScalar cpower = power;
581b2fb0278SBarry Smith   return PetscPowScalar(base,cpower);
582b2fb0278SBarry Smith }
58378a59e97SMatthew G. Knepley 
58478a59e97SMatthew G. Knepley #ifndef PETSC_HAVE_LOG2
58578a59e97SMatthew G. Knepley PETSC_STATIC_INLINE PetscReal PetscLog2Real(PetscReal n)
58678a59e97SMatthew G. Knepley {
58778a59e97SMatthew G. Knepley   return PetscLogReal(n)/PetscLogReal(2);
58878a59e97SMatthew G. Knepley }
58978a59e97SMatthew G. Knepley #endif
590e489efc1SBarry Smith #endif
591