/usr/include/deal.II/lac/slepc_spectral_transformation.h is in libdeal.ii-dev 6.3.1-1.1.
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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 | //---------------------------------------------------------------------------
// $Id: slepc_spectral_transformation.h 21132 2010-05-15 14:17:22Z kronbichler $
// Version: $Name$
// Author: Toby D. Young, Polish Academy of Sciences, 2009
//
// Copyright (C) 2009 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__slepc_spectral_transformation_h
#define __deal2__slepc_spectral_transformation_h
#include <base/config.h>
#ifdef DEAL_II_USE_SLEPC
# include <base/std_cxx1x/shared_ptr.h>
# include <lac/exceptions.h>
# include <petscksp.h>
# include <slepceps.h>
DEAL_II_NAMESPACE_OPEN
namespace SLEPcWrappers
{
/**
* Base class for spectral transformation classes using the SLEPc
* solvers which are selected based on flags passed to the spectral
* transformation.
*
* @ingroup SLEPcWrappers
* @author Toby D. Young 2009
**/
class TransformationBase
{
public:
/**
* Constructor. Takes the MPI
* communicator over which parallel
* computations are to happen.
*/
TransformationBase ();
/**
* Destructor.
*/
virtual ~TransformationBase ();
/**
* Record the EPS object that is associated
* to the spectral transformation
*/
void set_context (EPS &eps);
protected:
virtual void set_transformation_type (ST &st) const = 0;
private:
/**
* Objects of this type are
* explicitly created, but are
* destroyed when the surrounding
* solver object goes out of scope,
* or when we assign a new value to
* the pointer to this object. The
* respective Destroy functions are
* therefore written into the
* destructor of this object, even
* though the object does not have
* a constructor.
*/
struct TransformationData
{
/**
* Destructor.
*/
~TransformationData ();
/**
* Objects for Eigenvalue Problem
* Solver.
*/
ST st;
};
std_cxx1x::shared_ptr<TransformationData> transformation_data;
};
/**
* 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 AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Spectral
* Transformation context object,
* and sets the type of spectral
* transformationthat is
* appropriate for this class.
*/
virtual void set_transformation_type (ST &st) const;
};
/**
* 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 AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Spectral
* Transformation context object,
* and sets the type of spectral
* transformationthat is
* appropriate for this class.
*/
virtual void set_transformation_type (ST &st) const;
};
/**
* An implementation of the transformation interface using the SLEPc
* Spectrum Folding.
*
* @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 AdditionalData &data = AdditionalData());
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Spectral
* Transformation context object,
* and sets the type of spectral
* transformationthat is
* appropriate for this class.
*/
virtual void set_transformation_type (ST &st) const;
};
/**
* 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 and antishift parameter.
*/
const double shift_parameter;
const double antishift_parameter;
};
/**
* Constructor.
*/
TransformationCayley (const double shift,
const double antishift);
protected:
/**
* Store a copy of the flags for this
* particular solver.
*/
const AdditionalData additional_data;
/**
* Function that takes a Spectral
* Transformation context object,
* and sets the type of spectral
* transformationthat is
* appropriate for this class.
*/
virtual void set_transformation_type (ST &st) const;
};
}
DEAL_II_NAMESPACE_CLOSE
#endif // DEAL_II_USE_SLEPC
/*-------------------- slepc_spectral_transformation.h ------------------*/
#endif
/*-------------------- slepc_spectral_transformation.h ------------------*/
|