Class ae108::solve::NonlinearSolver

template <class Assembler>

ClassList > ae108 > solve > NonlinearSolver

Public Types

Type	Name
typedef std::vector< cpppetsc::ConstrainedDOF >	BoundaryConditionContainer
typedef std::function< void(const cpppetsc::distributed< cpppetsc::Vector > &, double, cpppetsc::distributed< cpppetsc::Vector > *)>	DistributedForceVectorAssembler
typedef std::function< void(const cpppetsc::distributed< cpppetsc::Vector > &, double, cpppetsc::Matrix *)>	DistributedStiffnessMatrixAssembler
typedef std::function< void(const cpppetsc::local< cpppetsc::Vector > &, double, cpppetsc::local< cpppetsc::Vector > *)>	LocalForceVectorAssembler
typedef std::function< void(const cpppetsc::local< cpppetsc::Vector > &, double, cpppetsc::Matrix *)>	LocalStiffnessMatrixAssembler
typedef typename cpppetsc::NonlinearSolver::Tolerances::real_type	real_type
typedef typename cpppetsc::Mesh::size_type	size_type
typedef typename cpppetsc::Mesh::value_type	value_type

Public Functions

Type	Name
	NonlinearSolver (const cpppetsc::Mesh * mesh)
	NonlinearSolver (const cpppetsc::Mesh * mesh, const real_type abstol, const real_type rtol)
cpppetsc::distributed< cpppetsc::Vector >	computeSolution (const BoundaryConditionContainer & boundaryConditions, cpppetsc::distributed< cpppetsc::Vector > initialGuess, const double time, const Assembler const assembler) const Calls computeSolution with the default assembler calls (ie. calls assembleForceVector or assembleStiffnessMatrix). Passes on the rest of the arguments.*
cpppetsc::distributed< cpppetsc::Vector >	computeSolution (const BoundaryConditionContainer & boundaryConditions, cpppetsc::distributed< cpppetsc::Vector > initialGuess, const double time, LocalForceVectorAssembler assembleForceVector, LocalStiffnessMatrixAssembler assembleStiffnessMatrix) const Calls computeSolution wrapping up the local assembler calls into distributed assembler calls. Passes on the rest of the arguments.
cpppetsc::distributed< cpppetsc::Vector >	computeSolution (const BoundaryConditionContainer & boundaryConditions, cpppetsc::distributed< cpppetsc::Vector > initialGuess, const double time, DistributedForceVectorAssembler assembleForceVector, DistributedStiffnessMatrixAssembler assembleStiffnessMatrix) const The goal of this function is to solve E(x) = min under the condition that all the essential boundary conditions x_i = a_i are met.

Public Types Documentation

typedef BoundaryConditionContainer

using ae108::solve::NonlinearSolver< Assembler >::BoundaryConditionContainer =  std::vector<cpppetsc::ConstrainedDOF>;

typedef DistributedForceVectorAssembler

using ae108::solve::NonlinearSolver< Assembler >::DistributedForceVectorAssembler =  std::function<void(const cpppetsc::distributed<cpppetsc::Vector> &, double, cpppetsc::distributed<cpppetsc::Vector> *)>;

typedef DistributedStiffnessMatrixAssembler

using ae108::solve::NonlinearSolver< Assembler >::DistributedStiffnessMatrixAssembler =  std::function<void(const cpppetsc::distributed<cpppetsc::Vector> &, double, cpppetsc::Matrix *)>;

typedef LocalForceVectorAssembler

using ae108::solve::NonlinearSolver< Assembler >::LocalForceVectorAssembler =  std::function<void(const cpppetsc::local<cpppetsc::Vector> &, double, cpppetsc::local<cpppetsc::Vector> *)>;

typedef LocalStiffnessMatrixAssembler

using ae108::solve::NonlinearSolver< Assembler >::LocalStiffnessMatrixAssembler =  std::function<void( const cpppetsc::local<cpppetsc::Vector> &, double, cpppetsc::Matrix *)>;

typedef real_type

using ae108::solve::NonlinearSolver< Assembler >::real_type =  typename cpppetsc::NonlinearSolver::Tolerances::real_type;

typedef size_type

using ae108::solve::NonlinearSolver< Assembler >::size_type =  typename cpppetsc::Mesh::size_type;

typedef value_type

using ae108::solve::NonlinearSolver< Assembler >::value_type =  typename cpppetsc::Mesh::value_type;

Public Functions Documentation

function NonlinearSolver [1/2]

explicit ae108::solve::NonlinearSolver::NonlinearSolver (
    const cpppetsc::Mesh * mesh
)

Parameters:

mesh A valid nonzero pointer to a cpppetsc::Mesh instance.

function NonlinearSolver [2/2]

ae108::solve::NonlinearSolver::NonlinearSolver (
    const cpppetsc::Mesh * mesh,
    const real_type abstol,
    const real_type rtol
)

Parameters:

mesh A valid nonzero pointer to a cpppetsc::Mesh instance.
abstol Absolute convergence tolerance.
rtol Relative convergence tolerance.

function computeSolution [1/3]

Calls computeSolution with the default assembler calls (ie. calls assembleForceVector or assembleStiffnessMatrix). Passes on the rest of the arguments.

cpppetsc::distributed < cpppetsc::Vector > ae108::solve::NonlinearSolver::computeSolution (
    const BoundaryConditionContainer & boundaryConditions,
    cpppetsc::distributed < cpppetsc::Vector > initialGuess,
    const double time,
    const Assembler *const assembler
) const

Parameters:

boundaryConditions The local essential boundary conditions to apply.
initialGuess The global vector to start iterating at.
time This will be used to configure the assembler. @para assembler Valid nonzero pointer.

function computeSolution [2/3]

Calls computeSolution wrapping up the local assembler calls into distributed assembler calls. Passes on the rest of the arguments.

cpppetsc::distributed < cpppetsc::Vector > ae108::solve::NonlinearSolver::computeSolution (
    const BoundaryConditionContainer & boundaryConditions,
    cpppetsc::distributed < cpppetsc::Vector > initialGuess,
    const double time,
    LocalForceVectorAssembler assembleForceVector,
    LocalStiffnessMatrixAssembler assembleStiffnessMatrix
) const

Parameters:

boundaryConditions The local essential boundary conditions to apply.
initialGuess The global vector to start iterating at.
time This will be used to configure the assembler.
assembleForceVector A valid callable. It will be called to assemble the local force vector.
assembleStiffnessMatrix A valid callable. It will be called to assemble the stiffness matrix.

function computeSolution [3/3]

The goal of this function is to solve E(x) = min under the condition that all the essential boundary conditions x_i = a_i are met.

cpppetsc::distributed < cpppetsc::Vector > ae108::solve::NonlinearSolver::computeSolution (
    const BoundaryConditionContainer & boundaryConditions,
    cpppetsc::distributed < cpppetsc::Vector > initialGuess,
    const double time,
    DistributedForceVectorAssembler assembleForceVector,
    DistributedStiffnessMatrixAssembler assembleStiffnessMatrix
) const

Remark:

Applying a nonlinear solver, we actually solve F(x) := grad E(x) = 0 on the subspace where the boundary conditions are satisfied. We turn this problem into a problem for all x by defining f_i(x) := F_i(x) for subspace coordinates i and f_i(x) = x_i - a_i else. The equation to solve therefore is: f(x) = 0.

Remark:

Does not update internal variables.

Parameters:

boundaryConditions The local essential boundary conditions to apply.
initialGuess The global vector to start iterating at.
time This will be used to configure the assembler.
assembleForceVector A valid callable. It will be called to assemble the distributed force vector.
assembleStiffnessMatrix A valid callable. It will be called to assemble the stiffness matrix.

The documentation for this class was generated from the following file solve/src/include/ae108/solve/NonlinearSolver.h