KrylovSolverOptions Class Reference

#include <KrylovSolverOptions.hpp>

Inheritance diagram for KrylovSolverOptions:

[legend]

Collaboration diagram for KrylovSolverOptions:

[legend]

List of all members.

Public Types
enum	Type {   conjugateGradient, biConjugateGradient, biConjugateGradientStabilized, fgmres,   gmres, iterativeLUFactorization }
enum	PreconditionerType {   diagonal, incompleteCholeski, multiGrid, spectralFEM,   none }
Public Member Functions
Type	type ()
PreconditionerType	precond ()
	KrylovSolverOptions ()
	~KrylovSolverOptions ()
void	get (IdentifierSet &I)
const ReferenceCounting < Parameter >	get (const char *parameterName) const
void	reset ()
Static Public Member Functions
static const char *	identifier ()
Protected Member Functions
template<typename EnumType>
void	get (const char *label, EnumType &e) const
void	get (const char *label, real_t &d) const
void	get (const char *label, int &i) const
void	get (const char *label, std::string &s) const
void	add (ReferenceCounting< Parameter > p)
Private Member Functions
std::ostream &	put (std::ostream &os) const
Friends
std::ostream &	operator<< (std::ostream &os, const ParametrizableObject &P)
	Writes the ParametrizableObject.

---

Detailed Description

Definition at line 25 of file KrylovSolverOptions.hpp.

---

Member Enumeration Documentation

enum KrylovSolverOptions::Type

Enumerator:

conjugateGradient
biConjugateGradient
biConjugateGradientStabilized
fgmres
gmres
iterativeLUFactorization

Definition at line 36 of file KrylovSolverOptions.hpp.

            {
    conjugateGradient,
    biConjugateGradient,
    biConjugateGradientStabilized,
    fgmres,
    gmres,
    iterativeLUFactorization
  };

enum KrylovSolverOptions::PreconditionerType

Enumerator:

diagonal
incompleteCholeski
multiGrid
spectralFEM
none

Definition at line 45 of file KrylovSolverOptions.hpp.

                          {
    diagonal,
    incompleteCholeski,
    multiGrid,
    spectralFEM,
    none
  };

---

Constructor & Destructor Documentation

KrylovSolverOptions::KrylovSolverOptions

(

)

[inline, explicit]

Definition at line 73 of file KrylovSolverOptions.hpp.

References biConjugateGradient, biConjugateGradientStabilized, conjugateGradient, diagonal, fgmres, gmres, incompleteCholeski, iterativeLUFactorization, multiGrid, none, and spectralFEM.

  {
    // autodoc:"is used to select the type of solver"
    EnumParameter<Type>* E1
      = new EnumParameter<Type>(KrylovSolverOptions::
				conjugateGradient,"type");

    // autodoc: "selects the conjugate gradient"
    (*E1).addSwitch("cg",
                   KrylovSolverOptions::conjugateGradient);
    // autodoc: "selects the bi-conjugate gradient (for non symetric problems)"
    (*E1).addSwitch("bicg",
                   KrylovSolverOptions::biConjugateGradient);
    // autodoc: "selects the bi-conjugate gradient stabilized (for non symetric problems)"
    (*E1).addSwitch("bicgstab",
                   KrylovSolverOptions::biConjugateGradientStabilized);
    // autodoc: "selects the flexible general minimum residual method (for non symetric problems)"
    (*E1).addSwitch("fgmres",
                   KrylovSolverOptions::fgmres);
    // autodoc: "selects the general minimum residual method (for non symetric problems)"
    (*E1).addSwitch("gmres",
                   KrylovSolverOptions::gmres);
    // autodoc: "selects the iterative LU factorization"
    (*E1).addSwitch("ilufact",
                   KrylovSolverOptions::iterativeLUFactorization);
    add(E1);


    // autodoc: "is used to select the preconditioner"
    EnumParameter<PreconditionerType>* E2
      = new EnumParameter<PreconditionerType>(KrylovSolverOptions::none,
                                              "precond");

    // autodoc: "preconditions with the diagonal of the operator"
    (*E2).addSwitch("diagonal",
                   KrylovSolverOptions::diagonal);
    // autodoc: "incomplete choleski factorization"
    (*E2).addSwitch("ichol",
                   KrylovSolverOptions::incompleteCholeski);
    // autodoc: "multigrid finite difference solver. By now, the grid must be $(2^{n_x}+1)\times(2^{n_y}+1)\times(2^{n_z}+1)$."
    (*E2).addSwitch("multigrid",
                   KrylovSolverOptions::multiGrid);
    // autodoc: "preconditions a spectral method by a finite element method"
    (*E2).addSwitch("sfem",
                   KrylovSolverOptions::spectralFEM);
    // autodoc: "no preconditioning"
    (*E2).addSwitch("none",
                   KrylovSolverOptions::none);
    add(E2);
  }

KrylovSolverOptions::~KrylovSolverOptions

(

)

[inline]

Definition at line 124 of file KrylovSolverOptions.hpp.

  {
    ;
  }

---

Member Function Documentation

std::ostream& KrylovSolverOptions::put

(

std::ostream &

os

)

const [inline, private, virtual]

Implements ParametrizableObject.

Definition at line 29 of file KrylovSolverOptions.hpp.

References identifier().

  {
    os << this->identifier();
    return os;
  }

Here is the call graph for this function:

Type KrylovSolverOptions::type

(

)

[inline]

Definition at line 53 of file KrylovSolverOptions.hpp.

References conjugateGradient.

Referenced by KrylovSolver::KrylovSolver().

  {
    KrylovSolverOptions::Type t = conjugateGradient;
    get("type", t);
    return t;
  }

PreconditionerType KrylovSolverOptions::precond

(

)

[inline]

Definition at line 60 of file KrylovSolverOptions.hpp.

References none.

Referenced by KrylovSolver::KrylovSolver().

  {
    KrylovSolverOptions::PreconditionerType t = none;
    get("precond", t);
    return t;
  }

static const char* KrylovSolverOptions::identifier

(

)

[inline, static]

Definition at line 67 of file KrylovSolverOptions.hpp.

Referenced by put().

  {
    // autodoc: "used to modify krylov solver"
    return "krylov";
  }

void ParametrizableObject::get

(

IdentifierSet &

I

)

[inline, inherited]

Definition at line 54 of file ParametrizableObject.hpp.

References ParametrizableObject::__parameters.

  {
    for (ParameterList::iterator i = __parameters.begin();
         i != __parameters.end(); ++i)
      {
        (*(*i).second).get(I);
        I.insert((*i).first);
      }
  }

template<typename EnumType>

void ParametrizableObject::get	(	const char *	label,
		EnumType &	e
	)			const [inline, protected, inherited]

Definition at line 71 of file ParametrizableObject.hpp.

References Parameter::Enum.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Enum) {
      e = dynamic_cast<const EnumParameter<EnumType>&>(*p);
      return;
    }
  }

void ParametrizableObject::get	(	const char *	label,
		real_t &	d
	)			const [inline, protected, inherited]

Definition at line 80 of file ParametrizableObject.hpp.

References Parameter::Double.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Double) {
      d = dynamic_cast<const DoubleParameter&>(*p);
      return;
    }      
  }

void ParametrizableObject::get	(	const char *	label,
		int &	i
	)			const [inline, protected, inherited]

Definition at line 89 of file ParametrizableObject.hpp.

References Parameter::Integer.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::Integer) {
      i = dynamic_cast<const IntegerParameter&>(*p);
      return;
    }      
  }

void ParametrizableObject::get	(	const char *	label,
		std::string &	s
	)			const [inline, protected, inherited]

Definition at line 98 of file ParametrizableObject.hpp.

References Parameter::String.

  {
    ReferenceCounting<Parameter> p = get(label);
    if((*p).type() == Parameter::String) {
      s = dynamic_cast<const StringParameter&>(*p);
      return;
    }      
  }

const ReferenceCounting<Parameter> ParametrizableObject::get

(

const char *

parameterName

)

const [inline, inherited]

Definition at line 117 of file ParametrizableObject.hpp.

References ParametrizableObject::__parameters, ErrorHandler::normal, and stringify().

  {
    ParameterList::const_iterator i = __parameters.find(parameterName);
    if (i != __parameters.end()) {
      return (*i).second;
    } else {
      throw ErrorHandler(__FILE__,__LINE__,
                         stringify(parameterName)+" not found",
                         ErrorHandler::normal);
      return 0;
    }
  }

Here is the call graph for this function:

void ParametrizableObject::add

(

ReferenceCounting< Parameter >

p

)

[inline, protected, inherited]

Definition at line 65 of file ParametrizableObject.hpp.

References ParametrizableObject::__parameters.

  {
    __parameters[(*p).label()] = p;
  }

void ParametrizableObject::reset

(

)

[inline, inherited]

Definition at line 109 of file ParametrizableObject.hpp.

References ParametrizableObject::__parameters.

  {
    for (ParameterList::iterator i = __parameters.begin();
         i != __parameters.end(); ++i) {
      (*(*i).second).reset();
    }
  }

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const ParametrizableObject &	P
	)			[friend, inherited]

Writes the ParametrizableObject.

Definition at line 22 of file ParametrizableObject.cpp.

{
  os  << P.put(os);
  return os;
}

---

The documentation for this class was generated from the following file:

• KrylovSolverOptions.hpp