WaveBlocksND
Public Types | Public Member Functions | List of all members
waveblocks::potentials::modules::taylor::Abstract< Subtype, Basis > Struct Template Reference

Abstract class for potential evaluation. More...

#include <taylor.hpp>

Public Types

using Self = Abstract< Subtype, Basis >
 

Public Member Functions

template<template< typename... > class Tuple = std::tuple>
Tuple< potential_evaluation_type, jacobian_evaluation_type, hessian_evaluation_type > taylor_at (const argument_type &g) const
 
template<template< typename... > class Tuple = std::tuple, template< typename... > class grid_in = std::vector, template< typename... > class grid_out = grid_in>
grid_out< Tuple< potential_evaluation_type, jacobian_evaluation_type, hessian_evaluation_type > > taylor (const grid_in< argument_type > &args) const
 

Detailed Description

template<class Subtype, class Basis>
struct waveblocks::potentials::modules::taylor::Abstract< Subtype, Basis >

Abstract class for potential evaluation.

A matrix potential inheriting an implementation of this module can evaluate its potential, jacobian and hessian in one or multiple points

This makes use of the CRTPattern

Template Parameters
SubtypeThe type extending this interface (used for static polymorphism)
BasisWhich basis (bases::Eigen or bases::Canonical) the potential is given in

Member Typedef Documentation

template<class Subtype, class Basis>
using waveblocks::potentials::modules::taylor::Abstract< Subtype, Basis >::Self = Abstract<Subtype, Basis>

Member Function Documentation

template<class Subtype, class Basis>
template<template< typename... > class Tuple = std::tuple, template< typename... > class grid_in = std::vector, template< typename... > class grid_out = grid_in>
grid_out< Tuple<potential_evaluation_type,jacobian_evaluation_type,hessian_evaluation_type> > waveblocks::potentials::modules::taylor::Abstract< Subtype, Basis >::taylor ( const grid_in< argument_type > &  args) const
inline
template<class Subtype, class Basis>
template<template< typename... > class Tuple = std::tuple>
Tuple<potential_evaluation_type, jacobian_evaluation_type, hessian_evaluation_type> waveblocks::potentials::modules::taylor::Abstract< Subtype, Basis >::taylor_at ( const argument_type &  g) const
inline

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