#include <NullSolver.h>

Inheritance diagram for ippl::NullSolver< FieldLHS, FieldRHS >:

Collaboration diagram for ippl::NullSolver< FieldLHS, FieldRHS >:

Public Types
using	Base = Poisson< FieldLHS, FieldRHS >

using	lhs_type = FieldLHS

using	rhs_type = FieldRHS

enum	OutputType { SOL = 0b01 , GRAD = 0b10 , SOL_AND_GRAD = 0b11 }

using	Tlhs = typename FieldLHS::value_type

using	Trhs = typename FieldRHS::value_type

using	grad_type = Field< Vector< Tlhs, Dim >, Dim, Mesh, Centering >

Public Member Functions
	NullSolver ()

	NullSolver (rhs_type &rhs)

	NullSolver (lhs_type &lhs, rhs_type &rhs)

void	solve () override

template<typename T >
void	updateParameter (const std::string &key, const T &value)

void	updateParameters (const ParameterList &params)

void	mergeParameters (const ParameterList &params)

void	setLhs (lhs_type &lhs)

virtual void	setRhs (rhs_type &rhs)

virtual MField_t *	getHessian ()

void	setGradient (grad_type &grad)

Protected Member Functions
virtual void	setDefaultParameters ()

Protected Attributes
ParameterList	params_m

rhs_type *	rhs_mp = nullptr

lhs_type *	lhs_mp = nullptr

grad_type *	grad_mp

Private Types
typedef FieldLHS::Mesh_t	Mesh

typedef FieldLHS::Centering_t	Centering

typedef Mesh::matrix_type	Matrix_t

typedef Field< Matrix_t, Dim, Mesh, Centering >	MField_t

Static Private Attributes
static constexpr unsigned	Dim = FieldLHS::dim

Detailed Description

template<typename FieldLHS, typename FieldRHS>
class ippl::NullSolver< FieldLHS, FieldRHS >

Definition at line 16 of file NullSolver.h.

Member Typedef Documentation

◆ Base

template<typename FieldLHS , typename FieldRHS >

using ippl::NullSolver< FieldLHS, FieldRHS >::Base = Poisson<FieldLHS, FieldRHS>

Definition at line 18 of file NullSolver.h.

◆ Centering

template<typename FieldLHS , typename FieldRHS >

typedef FieldLHS::Centering_t ippl::Poisson< FieldLHS, FieldRHS >::Centering

privateinherited

Definition at line 19 of file Poisson.h.

◆ grad_type

template<typename FieldLHS , typename FieldRHS >

using ippl::Poisson< FieldLHS, FieldRHS >::grad_type = Field<Vector<Tlhs, Dim>, Dim, Mesh, Centering>

inherited

Definition at line 29 of file Poisson.h.

◆ lhs_type

template<typename FieldLHS , typename FieldRHS >

using ippl::Poisson< FieldLHS, FieldRHS >::lhs_type = FieldLHS

Definition at line 24 of file Poisson.h.

◆ Matrix_t

template<typename FieldLHS , typename FieldRHS >

typedef Mesh::matrix_type ippl::Poisson< FieldLHS, FieldRHS >::Matrix_t

privateinherited

Definition at line 20 of file Poisson.h.

◆ Mesh

template<typename FieldLHS , typename FieldRHS >

typedef FieldLHS::Mesh_t ippl::Poisson< FieldLHS, FieldRHS >::Mesh

privateinherited

Definition at line 18 of file Poisson.h.

◆ MField_t

template<typename FieldLHS , typename FieldRHS >

typedef Field<Matrix_t, Dim, Mesh, Centering> ippl::Poisson< FieldLHS, FieldRHS >::MField_t

privateinherited

Definition at line 21 of file Poisson.h.

◆ rhs_type

template<typename FieldLHS , typename FieldRHS >

using ippl::Poisson< FieldLHS, FieldRHS >::rhs_type = FieldRHS

Definition at line 25 of file Poisson.h.

◆ Tlhs

template<typename FieldLHS , typename FieldRHS >

using ippl::Poisson< FieldLHS, FieldRHS >::Tlhs = typename FieldLHS::value_type

inherited

Definition at line 26 of file Poisson.h.

◆ Trhs

template<typename FieldLHS , typename FieldRHS >

using ippl::Poisson< FieldLHS, FieldRHS >::Trhs = typename FieldRHS::value_type

inherited

Definition at line 27 of file Poisson.h.

Member Enumeration Documentation

◆ OutputType

template<typename FieldLHS , typename FieldRHS >

enum ippl::Poisson::OutputType

inherited

Represents the types of fields that should be output by the solver

Enumerator
SOL
GRAD
SOL_AND_GRAD

Definition at line 35 of file Poisson.h.

Constructor & Destructor Documentation

◆ NullSolver() [1/3]

template<typename FieldLHS , typename FieldRHS >

ippl::NullSolver< FieldLHS, FieldRHS >::NullSolver ( )

inline

Definition at line 22 of file NullSolver.h.

◆ NullSolver() [2/3]

template<typename FieldLHS , typename FieldRHS >

ippl::NullSolver< FieldLHS, FieldRHS >::NullSolver ( rhs_type & rhs )

inline

Definition at line 25 of file NullSolver.h.

References ippl::Poisson< FieldLHS, FieldRHS >::setDefaultParameters(), and ippl::Poisson< FieldLHS, FieldRHS >::setRhs().

Here is the call graph for this function:

◆ NullSolver() [3/3]

template<typename FieldLHS , typename FieldRHS >

ippl::NullSolver< FieldLHS, FieldRHS >::NullSolver	(	lhs_type &	lhs,
		rhs_type &	rhs
	)

inline

Definition at line 33 of file NullSolver.h.

Member Function Documentation

◆ getHessian()

template<typename FieldLHS , typename FieldRHS >

virtual MField_t * ippl::Poisson< FieldLHS, FieldRHS >::getHessian ( )

inlinevirtualinherited

Get the Hessian matrix of the solution

Returns: Matrix field containing the Hessian of the lhs

Reimplemented in ippl::FFTOpenPoissonSolver< FieldLHS, FieldRHS >.

Definition at line 102 of file Poisson.h.

◆ mergeParameters()

template<typename FieldLHS , typename FieldRHS >

void ippl::Poisson< FieldLHS, FieldRHS >::mergeParameters ( const ParameterList & params )

inlineinherited

Merges another parameter set into the solver's parameters, overwriting existing parameters in case of conflict

Parameters

params Parameter list with desired values

Definition at line 84 of file Poisson.h.

References ippl::ParameterList::merge(), and ippl::Poisson< FieldLHS, FieldRHS >::params_m.

Here is the call graph for this function:

◆ setDefaultParameters()

template<typename FieldLHS , typename FieldRHS >

virtual void ippl::Poisson< FieldLHS, FieldRHS >::setDefaultParameters ( )

inlineprotectedvirtualinherited

Utility function for initializing a solver's default parameters (to be overridden for each base class)

Reimplemented in ippl::FEMPoissonSolver< FieldLHS, FieldRHS, Order, QuadNumNodes >, ippl::FFTOpenPoissonSolver< FieldLHS, FieldRHS >, ippl::FFTPeriodicPoissonSolver< FieldLHS, FieldRHS >, ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >, ippl::PoissonCG< FieldLHS, FieldRHS >, and ippl::PreconditionedFEMPoissonSolver< FieldLHS, FieldRHS >.

Definition at line 131 of file Poisson.h.

References ippl::ParameterList::add(), and ippl::Poisson< FieldLHS, FieldRHS >::SOL.

Referenced by ippl::NullSolver< FieldLHS, FieldRHS >::NullSolver(), and ippl::Poisson< FieldLHS, FieldRHS >::Poisson().

Here is the call graph for this function:

◆ setGradient()

template<typename FieldLHS , typename FieldRHS >

void ippl::Poisson< FieldLHS, FieldRHS >::setGradient ( grad_type & grad )

inlineinherited

Set the field in which the gradient of the computed potential should be stored

Parameters

grad	Reference to field in which to store the gradient

Definition at line 109 of file Poisson.h.

References ippl::grad(), and ippl::Poisson< FieldLHS, FieldRHS >::grad_mp.

Here is the call graph for this function:

◆ setLhs()

template<typename FieldLHS , typename FieldRHS >

void ippl::Poisson< FieldLHS, FieldRHS >::setLhs ( lhs_type & lhs )

inlineinherited

Set the problem LHS

Parameters

lhs	Reference to problem LHS field

Definition at line 90 of file Poisson.h.

References ippl::Poisson< FieldLHS, FieldRHS >::lhs_mp.

Referenced by ippl::FFTOpenPoissonSolver< FieldLHS, FieldRHS >::FFTOpenPoissonSolver(), ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >::FFTTruncatedGreenPeriodicPoissonSolver(), and ippl::Poisson< FieldLHS, FieldRHS >::Poisson().

◆ setRhs()

template<typename FieldLHS , typename FieldRHS >

virtual void ippl::Poisson< FieldLHS, FieldRHS >::setRhs ( rhs_type & rhs )

inlinevirtualinherited

Set the problem RHS

Parameters

rhs	Reference to problem RHS field

Reimplemented in ippl::FFTOpenPoissonSolver< FieldLHS, FieldRHS >, ippl::FFTPeriodicPoissonSolver< FieldLHS, FieldRHS >, and ippl::FFTTruncatedGreenPeriodicPoissonSolver< FieldLHS, FieldRHS >.

Definition at line 96 of file Poisson.h.

References ippl::Poisson< FieldLHS, FieldRHS >::rhs_mp.

Referenced by ippl::NullSolver< FieldLHS, FieldRHS >::NullSolver(), ippl::Poisson< FieldLHS, FieldRHS >::Poisson(), ippl::FEMPoissonSolver< FieldLHS, FieldRHS, Order, QuadNumNodes >::setRhs(), and ippl::PreconditionedFEMPoissonSolver< FieldLHS, FieldRHS >::setRhs().

◆ solve()

template<typename FieldLHS , typename FieldRHS >

void ippl::NullSolver< FieldLHS, FieldRHS >::solve ( )

inlineoverridevirtual

Solve the Poisson problem described by -laplace(lhs) = rhs

Implements ippl::Poisson< FieldLHS, FieldRHS >.

Definition at line 36 of file NullSolver.h.

References ippl::Poisson< FieldLHS, FieldRHS >::lhs_mp, and ippl::Poisson< FieldLHS, FieldRHS >::rhs_mp.

◆ updateParameter()

template<typename FieldLHS , typename FieldRHS >

template<typename T >

void ippl::Poisson< FieldLHS, FieldRHS >::updateParameter	(	const std::string &	key,
		const T &	value
	)

inlineinherited

Update one of the solver's parameters

Parameters

key	The parameter key
value	The new value

Exceptions

IpplException Fails if there is no existing parameter with the given key

Definition at line 67 of file Poisson.h.

References ippl::Poisson< FieldLHS, FieldRHS >::params_m, and ippl::ParameterList::update().

Here is the call graph for this function:

◆ updateParameters()

template<typename FieldLHS , typename FieldRHS >

void ippl::Poisson< FieldLHS, FieldRHS >::updateParameters ( const ParameterList & params )

inlineinherited

Updates all solver parameters based on values in another parameter set

Parameters

params Parameter list with updated values

Exceptions

IpplException Fails if the provided parameter list includes keys not already present

Definition at line 77 of file Poisson.h.

References ippl::Poisson< FieldLHS, FieldRHS >::params_m, and ippl::ParameterList::update().

Here is the call graph for this function:

Member Data Documentation

◆ Dim

template<typename FieldLHS , typename FieldRHS >

constexpr unsigned ippl::Poisson< FieldLHS, FieldRHS >::Dim = FieldLHS::dim

staticconstexprprivateinherited

Definition at line 17 of file Poisson.h.

◆ grad_mp

template<typename FieldLHS , typename FieldRHS >

grad_type* ippl::Poisson< FieldLHS, FieldRHS >::grad_mp

protectedinherited

Definition at line 125 of file Poisson.h.

Referenced by ippl::Poisson< FieldLHS, FieldRHS >::setGradient().

◆ lhs_mp

template<typename FieldLHS , typename FieldRHS >

lhs_type* ippl::Poisson< FieldLHS, FieldRHS >::lhs_mp = nullptr

protectedinherited

Definition at line 123 of file Poisson.h.

Referenced by ippl::Poisson< FieldLHS, FieldRHS >::setLhs(), and ippl::NullSolver< FieldLHS, FieldRHS >::solve().

◆ params_m

template<typename FieldLHS , typename FieldRHS >

ParameterList ippl::Poisson< FieldLHS, FieldRHS >::params_m

protectedinherited

Definition at line 120 of file Poisson.h.

◆ rhs_mp

template<typename FieldLHS , typename FieldRHS >

rhs_type* ippl::Poisson< FieldLHS, FieldRHS >::rhs_mp = nullptr

protectedinherited

Definition at line 122 of file Poisson.h.

Referenced by ippl::Poisson< FieldLHS, FieldRHS >::setRhs(), and ippl::NullSolver< FieldLHS, FieldRHS >::solve().

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

NullSolver.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ Base

◆ Centering

◆ grad_type

◆ lhs_type

◆ Matrix_t

◆ Mesh

◆ MField_t

◆ rhs_type

◆ Tlhs

◆ Trhs

Member Enumeration Documentation

◆ OutputType

Constructor & Destructor Documentation

◆ NullSolver() [1/3]

◆ NullSolver() [2/3]

◆ NullSolver() [3/3]

Member Function Documentation

◆ getHessian()

◆ mergeParameters()

◆ setDefaultParameters()

◆ setGradient()

◆ setLhs()

◆ setRhs()

◆ solve()

◆ updateParameter()

◆ updateParameters()

Member Data Documentation

◆ Dim

◆ grad_mp

◆ lhs_mp

◆ params_m

◆ rhs_mp