Grid 0.7.0
SolverModule< SolverType, Field, SPar > Class Template Referenceabstract

#include <SolverModules.h>

Inheritance diagram for SolverModule< SolverType, Field, SPar >:
Parametrized< SPar > HMCModuleBase< OperatorFunction< Field > >

Public Types

typedef HMCModuleBase< OperatorFunction< Field > > Base
typedef Base::Product Product
typedef SPar Parameters

Public Member Functions

 SolverModule (SPar Par)
template<class ReaderClass>
 SolverModule (Reader< ReaderClass > &Reader)
virtual void print_parameters ()
Product * getPtr ()
void set_parameters (Parameters Par)

Data Fields

std::unique_ptr< SolverType< Field > > SolverPtr

Protected Attributes

Parameters Par_

Private Member Functions

virtual void initialize ()=0

Private Attributes

std::string section_name

Detailed Description

template<template< typename > class SolverType, class Field, class SPar>
class SolverModule< SolverType, Field, SPar >

Definition at line 39 of file SolverModules.h.

Member Typedef Documentation

◆ Base

template<template< typename > class SolverType, class Field, class SPar>
typedef HMCModuleBase< OperatorFunction<Field> > SolverModule< SolverType, Field, SPar >::Base

Definition at line 43 of file SolverModules.h.

◆ Product

template<template< typename > class SolverType, class Field, class SPar>
typedef Base::Product SolverModule< SolverType, Field, SPar >::Product

Definition at line 44 of file SolverModules.h.

◆ Parameters

typedef SPar Parametrized< SPar >::Parameters
inherited

Definition at line 49 of file Modules.h.

Constructor & Destructor Documentation

◆ SolverModule() [1/2]

template<template< typename > class SolverType, class Field, class SPar>
SolverModule< SolverType, Field, SPar >::SolverModule ( SPar Par)
inline

Definition at line 48 of file SolverModules.h.

◆ SolverModule() [2/2]

template<template< typename > class SolverType, class Field, class SPar>
template<class ReaderClass>
SolverModule< SolverType, Field, SPar >::SolverModule ( Reader< ReaderClass > & Reader)
inline

Definition at line 51 of file SolverModules.h.

Member Function Documentation

◆ print_parameters()

template<template< typename > class SolverType, class Field, class SPar>
virtual void SolverModule< SolverType, Field, SPar >::print_parameters ( )
inlinevirtual

Reimplemented from HMCModuleBase< OperatorFunction< Field > >.

Definition at line 53 of file SolverModules.h.

◆ getPtr()

template<template< typename > class SolverType, class Field, class SPar>
Product * SolverModule< SolverType, Field, SPar >::getPtr ( )
inlinevirtual

Implements HMCModuleBase< OperatorFunction< Field > >.

Definition at line 57 of file SolverModules.h.

◆ initialize()

template<template< typename > class SolverType, class Field, class SPar>
virtual void SolverModule< SolverType, Field, SPar >::initialize ( )
privatepure virtual

Implemented in BiCGSTABModule< Field >, ConjugateGradientModule< Field >, and ConjugateResidualModule< Field >.

Referenced by SolverModule< ConjugateGradient, Field, SolverParameters >::getPtr().

◆ set_parameters()

void Parametrized< SPar >::set_parameters ( Parameters Par)
inlineinherited

Definition at line 58 of file Modules.h.

Field Documentation

◆ SolverPtr

template<template< typename > class SolverType, class Field, class SPar>
std::unique_ptr< SolverType<Field> > SolverModule< SolverType, Field, SPar >::SolverPtr

Definition at line 46 of file SolverModules.h.

◆ Par_

Parameters Parametrized< SPar >::Par_
protectedinherited

Definition at line 67 of file Modules.h.

◆ section_name

std::string Parametrized< SPar >::section_name
privateinherited

Definition at line 69 of file Modules.h.

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