Template deduction guides module

Class template argument deduction (CTAD) of Rodin's classes.

Functions

template<class LinearSystem>
BiCGSTAB(Variational::ProblemBase<LinearSystem>&) -> BiCGSTAB< LinearSystem >
CTAD for BiCGSTAB.
template<class LinearSystem>
CG(Variational::ProblemBase<LinearSystem>&) -> CG< LinearSystem >
CTAD (Class Template Argument Deduction) guide for CG.
template<class LinearSystem>
HouseholderQR(Variational::ProblemBase<LinearSystem>&) -> HouseholderQR< LinearSystem >
CTAD for HouseholderQR.
template<class LinearSystem>
LDLT(Variational::ProblemBase<LinearSystem>&) -> LDLT< LinearSystem >
CTAD (Class Template Argument Deduction) guide for LDLT.
template<class LinearSystem>
LeastSquaresCG(Variational::ProblemBase<LinearSystem>&) -> LeastSquaresCG< LinearSystem >
CTAD (Class Template Argument Deduction) guide for LeastSquaresCG.
template<class LinearSystemType>
SimplicialLDLT(Variational::ProblemBase<LinearSystemType>&) -> SimplicialLDLT< LinearSystemType >
CTAD (Class Template Argument Deduction) guide for SimplicialLDLT.
template<class LinearSystem>
SimplicialLLT(Variational::ProblemBase<LinearSystem>&) -> SimplicialLLT< LinearSystem >
CTAD (Class Template Argument Deduction) guide for SimplicialLLT.
template<class LinearSystem>
SparseLU(Variational::ProblemBase<LinearSystem>&) -> SparseLU< LinearSystem >
CTAD (Class Template Argument Deduction) guide for SparseLU.
template<class LinearSystem>
SparseQR(Variational::ProblemBase<LinearSystem>&) -> SparseQR< LinearSystem >
CTAD (Class Template Argument Deduction) guide for SparseQR.
template<class Solution, class FES, class FunctionDerived>
DirichletBC(const TrialFunction<Solution, FES>&, const FunctionBase<FunctionDerived>&) -> DirichletBC< TrialFunction< Solution, FES >, FunctionBase< FunctionDerived > >
CTAD for DirichletBC.
template<class FES, class Data>
Grad(const GridFunction<FES, Data>&) -> Grad< GridFunction< FES, Data > >
CTAD for Grad of a GridFunction.
template<class NestedDerived, class FES, ShapeFunctionSpaceType Space>
Grad(const ShapeFunction<NestedDerived, FES, Space>&) -> Grad< ShapeFunction< NestedDerived, FES, Space > >
CTAD for Grad of a ShapeFunction.
template<class FES>
LinearForm(const TestFunction<FES>& v) -> LinearForm< FES, Math::Vector< typename FormLanguage::Traits< FES >::ScalarType > >
CTAD for LinearForm.
template<class Range, class Data, class Mesh>
Grad(const GridFunction<P0<Range, Mesh>, Data>&) -> Grad< GridFunction< P0< Range, Mesh >, Data > >
CTAD for Grad of a P0 GridFunction.
template<class Context>
P0(const Geometry::Mesh<Context>&) -> P0< Real, Geometry::Mesh< Context > >
CTAD for P0 from mesh - deduces to RealP0.
template<class Range, class Data, class Mesh>
Derivative(size_t, const GridFunction<P1<Range, Mesh>, Data>&) -> Derivative< GridFunction< P1< Range, Mesh >, Data > >
CTAD for Derivative of a P1 GridFunction.
template<class Scalar, class Data, class Mesh>
Div(const GridFunction<P1<Math::Vector<Scalar>, Mesh>, Data>&) -> Div< GridFunction< P1< Math::Vector< Scalar >, Mesh >, Data > >
CTAD for Div of a P1 GridFunction.
template<class Range, class Data, class Mesh>
Jacobian(const GridFunction<P1<Range, Mesh>, Data>&) -> Jacobian< GridFunction< P1< Range, Mesh >, Data > >
CTAD for Jacobian of a P1 GridFunction.
template<class Context>
P1(const Geometry::Mesh<Context>&) -> P1< Real, Geometry::Mesh< Context > >
CTAD for P1 from mesh - deduces to RealP1.
template<class Solution, class FES>
PeriodicBC(const TrialFunction<Solution, FES>&, const IndexMap<IndexSet>&) -> PeriodicBC< TrialFunction< Solution, FES >, IndexMap< IndexSet > >
CTAD for PeriodicBC.

Function documentation

#include <Rodin/Solver/BiCGSTAB.h>
template<class LinearSystem>
BiCGSTAB(Variational::ProblemBase<LinearSystem>&) -> BiCGSTAB< LinearSystem >

CTAD for BiCGSTAB.

#include <Rodin/Solver/CG.h>
template<class LinearSystem>
CG(Variational::ProblemBase<LinearSystem>&) -> CG< LinearSystem >

CTAD (Class Template Argument Deduction) guide for CG.

#include <Rodin/Solver/HouseholderQR.h>
template<class LinearSystem>
HouseholderQR(Variational::ProblemBase<LinearSystem>&) -> HouseholderQR< LinearSystem >

CTAD for HouseholderQR.

#include <Rodin/Solver/LDLT.h>
template<class LinearSystem>
LDLT(Variational::ProblemBase<LinearSystem>&) -> LDLT< LinearSystem >

CTAD (Class Template Argument Deduction) guide for LDLT.

#include <Rodin/Solver/LeastSquaresCG.h>
template<class LinearSystem>
LeastSquaresCG(Variational::ProblemBase<LinearSystem>&) -> LeastSquaresCG< LinearSystem >

CTAD (Class Template Argument Deduction) guide for LeastSquaresCG.

#include <Rodin/Solver/SimplicialLDLT.h>
template<class LinearSystemType>
SimplicialLDLT(Variational::ProblemBase<LinearSystemType>&) -> SimplicialLDLT< LinearSystemType >

CTAD (Class Template Argument Deduction) guide for SimplicialLDLT.

#include <Rodin/Solver/SimplicialLLT.h>
template<class LinearSystem>
SimplicialLLT(Variational::ProblemBase<LinearSystem>&) -> SimplicialLLT< LinearSystem >

CTAD (Class Template Argument Deduction) guide for SimplicialLLT.

#include <Rodin/Solver/SparseLU.h>
template<class LinearSystem>
SparseLU(Variational::ProblemBase<LinearSystem>&) -> SparseLU< LinearSystem >

CTAD (Class Template Argument Deduction) guide for SparseLU.

#include <Rodin/Solver/SparseQR.h>
template<class LinearSystem>
SparseQR(Variational::ProblemBase<LinearSystem>&) -> SparseQR< LinearSystem >

CTAD (Class Template Argument Deduction) guide for SparseQR.

#include <Rodin/Variational/DirichletBC.h>
template<class Solution, class FES, class FunctionDerived>
DirichletBC(const TrialFunction<Solution, FES>&, const FunctionBase<FunctionDerived>&) -> DirichletBC< TrialFunction< Solution, FES >, FunctionBase< FunctionDerived > >

CTAD for DirichletBC.

Template parameters
FES Type of finite element space

#include <Rodin/Variational/Grad.h>
template<class FES, class Data>
Grad(const GridFunction<FES, Data>&) -> Grad< GridFunction< FES, Data > >

CTAD for Grad of a GridFunction.

#include <Rodin/Variational/Grad.h>
template<class NestedDerived, class FES, ShapeFunctionSpaceType Space>
Grad(const ShapeFunction<NestedDerived, FES, Space>&) -> Grad< ShapeFunction< NestedDerived, FES, Space > >

CTAD for Grad of a ShapeFunction.

#include <Rodin/Variational/LinearForm.h>
template<class FES>
LinearForm(const TestFunction<FES>& v) -> LinearForm< FES, Math::Vector< typename FormLanguage::Traits< FES >::ScalarType > >

CTAD for LinearForm.

Parameters
v in Reference to a TestFunction

The constructor taking a single TestFunction reference deduces a LinearForm with a default-constructed Math::Vector owned by the LinearForm instance.

#include <Rodin/Variational/P0/Grad.h>
template<class Range, class Data, class Mesh>
Grad(const GridFunction<P0<Range, Mesh>, Data>&) -> Grad< GridFunction< P0< Range, Mesh >, Data > >

CTAD for Grad of a P0 GridFunction.

#include <Rodin/Variational/P1/Derivative.h>
template<class Range, class Data, class Mesh>
Derivative(size_t, const GridFunction<P1<Range, Mesh>, Data>&) -> Derivative< GridFunction< P1< Range, Mesh >, Data > >

CTAD for Derivative of a P1 GridFunction.

#include <Rodin/Variational/P1/Div.h>
template<class Scalar, class Data, class Mesh>
Div(const GridFunction<P1<Math::Vector<Scalar>, Mesh>, Data>&) -> Div< GridFunction< P1< Math::Vector< Scalar >, Mesh >, Data > >

CTAD for Div of a P1 GridFunction.

#include <Rodin/Variational/P1/Jacobian.h>
template<class Range, class Data, class Mesh>
Jacobian(const GridFunction<P1<Range, Mesh>, Data>&) -> Jacobian< GridFunction< P1< Range, Mesh >, Data > >

CTAD for Jacobian of a P1 GridFunction.

#include <Rodin/Variational/PeriodicBC.h>
template<class Solution, class FES>
PeriodicBC(const TrialFunction<Solution, FES>&, const IndexMap<IndexSet>&) -> PeriodicBC< TrialFunction< Solution, FES >, IndexMap< IndexSet > >

CTAD for PeriodicBC.

Template parameters
FES Type of finite element space