File: slepc.ccm

package info (click to toggle)
deal.ii 9.7.1-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 326,024 kB
  • sloc: cpp: 440,899; ansic: 77,337; python: 3,307; perl: 1,041; sh: 1,022; xml: 252; makefile: 97; javascript: 14
file content (164 lines) | stat: -rw-r--r-- 5,493 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2025 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------


// It is very inefficient in the module system to have repeated
// #includes in many module partition files because when you 'import'
// those partitions, you also have to load everything they
// #included. In other words, you get the same content *many times*,
// once from each imported partition, rather than only once via the
// old-style #include system. We deal with this by wrapping all of our
// external packages into partitions that we can 'import' wherever we
// need.

// This is the file that wraps everything we need from SLEPC into one
// module partition.


module;

#include <deal.II/base/config.h>

#ifdef DEAL_II_WITH_SLEPC
#  include <slepceps.h>
#  include <slepcst.h>
#endif


export module dealii.external.slepc;

#ifdef DEAL_II_WITH_SLEPC

export
{
  using ::EPS;
  using ::EPSArnoldiSetDelayed;
  using ::EPSComputeError;
  using ::EPSConvergedReason;
  using ::EPSCreate;
  using ::EPSDestroy;
  using ::EPSGDSetDoubleExpansion;
  using ::EPSGetConverged;
  using ::EPSGetEigenpair;
  using ::EPSGetIterationNumber;
  using ::EPSLanczosReorthogType;
  using ::EPSLanczosSetReorthog;
  using ::EPSProblemType;
  using ::EPSSetConvergenceTest;
  using ::EPSSetDimensions;
  using ::EPSSetFromOptions;
  using ::EPSSetInitialSpace;
  using ::EPSSetOperators;
  using ::EPSSetProblemType;
  using ::EPSSetST;
  using ::EPSSetTarget;
  using ::EPSSetTolerances;
  using ::EPSSetType;
  using ::EPSSetWhichEigenpairs;
  using ::EPSSolve;
  using ::EPSWhich;
  using ::SlepcFinalize;
  using ::SlepcInitialize;
  using ::SlepcInitializeCalled;
  using ::ST;
  using ::STCayleySetAntishift;
  using ::STCreate;
  using ::STDestroy;
  using ::STMatMode;
  using ::STSetKSP;
  using ::STSetMatMode;
  using ::STSetShift;
  using ::STSetType;
}


// SLEPc also defines quite a lot of symbols that are either
// implemented as macros, or perhaps as constants in header
// files. In the former case, they cannot be referenced in 'using'
// expressions, and so we need to work around things by creating
// *variables* of the same names. In the latter case, they are often
// implemented as constants with internal linkage that we can't
// re-export (e.g., if they are members of anonymous enums).
//
// Dealing with this situation requires creating some other set of
// variable, undefining the macro names, and then creating variables
// with the same names as the macro names. Because we would end up
// with name clashes if these new variables were in the global
// namespace for those MPI implementations that implement things as
// variables in the global namespace, we put everything into the
// dealii namespace.
//
// We put the exportable symbols into namespace 'dealii'. This is
// necessary for cases where the symbol we create is derived not from
// a preprocessor macro, but for example as a member of an anonymous
// enum. Such symbols can't be exported, so we declare a variable that
// we *can* export, but it will not have the type of the enum, but of
// the underlying int. The compiler will therefore complain that the
// variable we're creating here redeclares another one but with a
// different type. We can avoid this by putting things into our own
// namespace.
#  define CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(sym)        \
    namespace dealii                                        \
    {                                                       \
      namespace Slepc_Macros                                \
      {                                                     \
        [[maybe_unused]] const auto exportable_##sym = sym; \
      }                                                     \
    } // namespace dealii

#  define EXPORT_PREPROCESSOR_SYMBOL(sym)                              \
    namespace dealii                                                   \
    {                                                                  \
      export const auto &sym = dealii::Slepc_Macros::exportable_##sym; \
    }



CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(EPSARNOLDI)
#  undef EPSARNOLDI
EXPORT_PREPROCESSOR_SYMBOL(EPSARNOLDI)

CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(EPSGD)
#  undef EPSGD
EXPORT_PREPROCESSOR_SYMBOL(EPSGD)

CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(EPSKRYLOVSCHUR)
#  undef EPSKRYLOVSCHUR
EXPORT_PREPROCESSOR_SYMBOL(EPSKRYLOVSCHUR)

CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(EPSJD)
#  undef EPSJD
EXPORT_PREPROCESSOR_SYMBOL(EPSJD)

CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(EPSLANCZOS)
#  undef EPSLANCZOS
EXPORT_PREPROCESSOR_SYMBOL(EPSLANCZOS)

CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(EPSPOWER)
#  undef EPSPOWER
EXPORT_PREPROCESSOR_SYMBOL(EPSPOWER)

CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(STSHIFT)
#  undef STSHIFT
EXPORT_PREPROCESSOR_SYMBOL(STSHIFT)

CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(STSINVERT)
#  undef STSINVERT
EXPORT_PREPROCESSOR_SYMBOL(STSINVERT)

CREATE_EXPORTABLE_PREPROCESSOR_SYMBOL(STCAYLEY)
#  undef STCAYLEY
EXPORT_PREPROCESSOR_SYMBOL(STCAYLEY)

#endif