/usr/include/deal.II/lac/slepc_spectral_transformation.h is in libdeal.ii-dev 8.4.2-2+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 | // ---------------------------------------------------------------------
//
// Copyright (C) 2009 - 2016 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------
#ifndef dealii__slepc_spectral_transformation_h
#define dealii__slepc_spectral_transformation_h
#include <deal.II/base/config.h>
#ifdef DEAL_II_WITH_SLEPC
# include <deal.II/base/std_cxx11/shared_ptr.h>
# include <deal.II/lac/exceptions.h>
# include <deal.II/lac/petsc_solver.h>
# include <petscksp.h>
# include <slepceps.h>
DEAL_II_NAMESPACE_OPEN
namespace PETScWrappers
{
// forward declarations
class SolverBase;
}
namespace SLEPcWrappers
{
/**
* Base class for spectral transformation classes using the SLEPc solvers
* which are selected based on flags passed to the spectral transformation.
*
* <code>SLEPcWrappers::TransformationXXX</code>, where <code>XXX</code> is
* your favourite transformation type, can then be implemented in
* application codes in the following way for <code>XXX=INVERT</code> with
* the solver object <code>eigensolver</code>:
* @code
* // Set a transformation, this one shifts the eigenspectrum by 3.142..
* SLEPcWrappers::TransformationShift::AdditionalData additional_data (3.142);
* SLEPcWrappers::TransformationShift shift (mpi_communicator,additional_data);
* eigensolver.set_transformation (shift);
* @endcode
* and later calling the <code>solve()</code> function as usual:
* @code
* SolverControl solver_control (1000, 1e-9);
* SolverArnoldi system (solver_control, mpi_communicator);
* eigensolver.solve (A, B, lambda, x, size_of_spectrum);
* @endcode
*
* @note These options can also be set at the command line.
*
* @ingroup SLEPcWrappers
* @author Toby D. Young 2009, 2013; and Denis Davydov 2015.
*/
class TransformationBase
{
protected:
/**
* Constructor.
*/
TransformationBase (const MPI_Comm &mpi_communicator);
public:
/**
* Destructor.
*/
virtual ~TransformationBase ();
/**
* Set a flag to indicate how the transformed matrices are being stored in
* the spectral transformations.
*
* The possible values are given by the enumerator STMatMode in the SLEPc
* library http://www.grycap.upv.es/slepc/documentation/current/docs/manua
* lpages/ST/STMatMode.html
*/
void set_matrix_mode(const STMatMode mode);
/**
* Set solver to be used when solving a system of linear algebraic
* equations inside the eigensolver.
*/
void
set_solver(const PETScWrappers::SolverBase &solver);
protected:
/**
* SLEPc spectral transformation object.
*/
ST st;
/**
* Make the solver class a friend, since it needs to set spectral
* transformation object.
*/
friend class SolverBase;
};
/**
* An implementation of the transformation interface using the SLEPc Shift.
*
* @ingroup SLEPcWrappers
* @author Toby D. Young 2009
*/
class TransformationShift : public TransformationBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{
/**
* Constructor. By default, set the shift parameter to zero.
*/
AdditionalData (const double shift_parameter = 0);
/**
* Shift parameter.
*/
const double shift_parameter;
};
/**
* Constructor.
*/
TransformationShift (const MPI_Comm &mpi_communicator,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the transformation interface using the SLEPc Shift
* and Invert.
*
* @ingroup SLEPcWrappers
* @author Toby D. Young 2009
*/
class TransformationShiftInvert : public TransformationBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{
/**
* Constructor. By default, set the shift parameter to zero.
*/
AdditionalData (const double shift_parameter = 0);
/**
* Shift parameter.
*/
const double shift_parameter;
};
/**
* Constructor.
*/
TransformationShiftInvert (const MPI_Comm &mpi_communicator,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the transformation interface using the SLEPc
* Spectrum Folding. This transformation type has been removed in SLEPc
* 3.5.0 and thus cannot be used in the newer versions.
*
* @ingroup SLEPcWrappers
* @author Toby D. Young 2009
*/
class TransformationSpectrumFolding : public TransformationBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{
/**
* Constructor. By default, set the shift parameter to zero.
*/
AdditionalData (const double shift_parameter = 0);
/**
* Shift parameter.
*/
const double shift_parameter;
};
/**
* Constructor.
*/
TransformationSpectrumFolding (const MPI_Comm &mpi_communicator,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
};
/**
* An implementation of the transformation interface using the SLEPc Cayley.
*
* @ingroup SLEPcWrappers
* @author Toby D. Young 2009
*/
class TransformationCayley : public TransformationBase
{
public:
/**
* Standardized data struct to pipe additional data to the solver.
*/
struct AdditionalData
{
/**
* Constructor. Requires two shift parameters
*/
AdditionalData (const double shift_parameter = 0,
const double antishift_parameter = 0);
/**
* Shift parameter.
*/
const double shift_parameter;
/**
* Antishift parameter.
*/
const double antishift_parameter;
};
/**
* Constructor.
*/
TransformationCayley (const MPI_Comm &mpi_communicator,
const AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this particular solver.
*/
const AdditionalData additional_data;
};
}
DEAL_II_NAMESPACE_CLOSE
#endif // DEAL_II_WITH_SLEPC
/*-------------------- slepc_spectral_transformation.h ------------------*/
#endif
/*-------------------- slepc_spectral_transformation.h ------------------*/
|