Arcane::AlinaLib::AlinaSolverParameters Class Reference

Handle parameters for solvers. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/alina/arccore/alina/AlinaLib.h>

Collaboration diagram for Arcane::AlinaLib::AlinaSolverParameters:

Public Member Functions
	AlinaSolverParameters ()
	Create a sequential solver.
	AlinaSolverParameters (MessagePassing::IMessagePassingMng *mpm, ITraceMng *tm=nullptr)
	Create a solver.
void	setInt32 (const char *name, Int32 value)
	Set Int32 parameter in the parameter list.
void	setInt64 (const char *name, Int64 value)
	Set Int64 parameter in the parameter list.
void	setReal (const char *name, Real value)
	Set floating point parameter in the parameter list.
void	setString (const char *name, const char *value)
	Set floating point parameter in the parameter list.
void	readFromJSON (const char *fname)
	Read parameters from a JSON file.
void	setSolverAbsoluteTolerance (Real value)
void	setSolverRelativeTolerance (Real value)
void	setSolverMaxIteration (Int32 value)
void	setSolverVerbosity (Int32 value)
void	setSolverPreconditioner (eAlinaPreconditionerType v)
void	setSolverType (eAlinaSolverType v)
ITraceMng *	traceMng () const

Private Attributes
friend	AlinaSolver
friend	AlinaSequentialSolverImpl
friend	AlinaDistributedSolverImpl
std::shared_ptr< AlinaSolverParametersImpl >	m_p

Detailed Description

Handle parameters for solvers.

This class uses a reference semantic for copy.

Definition at line 129 of file AlinaLib.h.

Constructor & Destructor Documentation

AlinaSolverParameters() [1/2]

Arcane::AlinaLib::AlinaSolverParameters::AlinaSolverParameters

(

)

Create a sequential solver.

Definition at line 180 of file AlinaLib.cc.

AlinaSolverParameters() [2/2]

Arcane::AlinaLib::AlinaSolverParameters::AlinaSolverParameters ( MessagePassing::IMessagePassingMng * mpm, ITraceMng * tm = nullptr )

explicit

Create a solver.

The solver is distributed if mpm is not null. Otherwise the solver is sequential

Definition at line 189 of file AlinaLib.cc.

~AlinaSolverParameters()

Arcane::AlinaLib::AlinaSolverParameters::~AlinaSolverParameters

(

)

Definition at line 198 of file AlinaLib.cc.

Member Function Documentation

readFromJSON()

void Arcane::AlinaLib::AlinaSolverParameters::readFromJSON

(

const char *

fname

)

Read parameters from a JSON file.

Definition at line 239 of file AlinaLib.cc.

setInt32()

void Arcane::AlinaLib::AlinaSolverParameters::setInt32	(	const char *	name,
		Arcane::Int32	value )

Set Int32 parameter in the parameter list.

Definition at line 215 of file AlinaLib.cc.

setInt64()

void Arcane::AlinaLib::AlinaSolverParameters::setInt64	(	const char *	name,
		Arcane::Int64	value )

Set Int64 parameter in the parameter list.

Definition at line 221 of file AlinaLib.cc.

setReal()

void Arcane::AlinaLib::AlinaSolverParameters::setReal	(	const char *	name,
		Arcane::Real	value )

Set floating point parameter in the parameter list.

Definition at line 227 of file AlinaLib.cc.

setSolverAbsoluteTolerance()

void Arcane::AlinaLib::AlinaSolverParameters::setSolverAbsoluteTolerance

(

Arcane::Real

value

)

Definition at line 249 of file AlinaLib.cc.

setSolverMaxIteration()

void Arcane::AlinaLib::AlinaSolverParameters::setSolverMaxIteration

(

Arcane::Int32

value

)

Definition at line 259 of file AlinaLib.cc.

setSolverPreconditioner()

void Arcane::AlinaLib::AlinaSolverParameters::setSolverPreconditioner

(

eAlinaPreconditionerType

v

)

Definition at line 273 of file AlinaLib.cc.

setSolverRelativeTolerance()

void Arcane::AlinaLib::AlinaSolverParameters::setSolverRelativeTolerance

(

Arcane::Real

value

)

Definition at line 254 of file AlinaLib.cc.

setSolverType()

void Arcane::AlinaLib::AlinaSolverParameters::setSolverType

(

eAlinaSolverType

v

)

Definition at line 291 of file AlinaLib.cc.

setSolverVerbosity()

void Arcane::AlinaLib::AlinaSolverParameters::setSolverVerbosity

(

Arcane::Int32

value

)

Definition at line 264 of file AlinaLib.cc.

setString()

void Arcane::AlinaLib::AlinaSolverParameters::setString	(	const char *	name,
		const char *	value )

Set floating point parameter in the parameter list.

Definition at line 233 of file AlinaLib.cc.

traceMng()

ITraceMng * Arcane::AlinaLib::AlinaSolverParameters::traceMng

(

)

const

Definition at line 206 of file AlinaLib.cc.

Member Data Documentation

AlinaDistributedSolverImpl

friend Arcane::AlinaLib::AlinaSolverParameters::AlinaDistributedSolverImpl

private

Definition at line 133 of file AlinaLib.h.

AlinaSequentialSolverImpl

friend Arcane::AlinaLib::AlinaSolverParameters::AlinaSequentialSolverImpl

private

Definition at line 132 of file AlinaLib.h.

AlinaSolver

friend Arcane::AlinaLib::AlinaSolverParameters::AlinaSolver

private

Definition at line 131 of file AlinaLib.h.

m_p

std::shared_ptr<AlinaSolverParametersImpl> Arcane::AlinaLib::AlinaSolverParameters::m_p

private

Definition at line 183 of file AlinaLib.h.

---

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

• AlinaLib.h
• AlinaLib.cc