ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
FieldCoupling::Fields::AffineMap< T, codim > Class Template Reference

Affine transform of a vector field. More...

#include <AffineMap.hpp>

Public Types

using value_type = typename Utils::decay_to_scalar< Utils::Vector< T, codim > >::type
 
using jacobian_type = detail::jacobian_type< T, codim >
 

Public Member Functions

 AffineMap (const jacobian_type &A, const value_type &b)
 
jacobian_typeA ()
 
value_typeb ()
 
value_type operator() (const Utils::Vector3d &pos, double={}) const
 
jacobian_type jacobian (const Utils::Vector3d &, double={}) const
 
bool fits_in_box (const Utils::Vector3d &) const
 

Detailed Description

template<typename T, std::size_t codim>
class FieldCoupling::Fields::AffineMap< T, codim >

Affine transform of a vector field.

Returns A * x + b, where * is matrix multiplication.

Definition at line 35 of file AffineMap.hpp.

Member Typedef Documentation

◆ jacobian_type

template<typename T , std::size_t codim>
using FieldCoupling::Fields::AffineMap< T, codim >::jacobian_type = detail::jacobian_type<T, codim>

Definition at line 39 of file AffineMap.hpp.

◆ value_type

template<typename T , std::size_t codim>
using FieldCoupling::Fields::AffineMap< T, codim >::value_type = typename Utils::decay_to_scalar<Utils::Vector<T, codim> >::type

Definition at line 37 of file AffineMap.hpp.

Constructor & Destructor Documentation

◆ AffineMap()

template<typename T , std::size_t codim>
FieldCoupling::Fields::AffineMap< T, codim >::AffineMap ( const jacobian_type A,
const value_type b 
)
inline

Definition at line 46 of file AffineMap.hpp.

Member Function Documentation

◆ A()

template<typename T , std::size_t codim>
jacobian_type & FieldCoupling::Fields::AffineMap< T, codim >::A ( )
inline

Definition at line 48 of file AffineMap.hpp.

◆ b()

template<typename T , std::size_t codim>
value_type & FieldCoupling::Fields::AffineMap< T, codim >::b ( )
inline

Definition at line 49 of file AffineMap.hpp.

◆ fits_in_box()

template<typename T , std::size_t codim>
bool FieldCoupling::Fields::AffineMap< T, codim >::fits_in_box ( const Utils::Vector3d ) const
inline

Definition at line 59 of file AffineMap.hpp.

◆ jacobian()

template<typename T , std::size_t codim>
jacobian_type FieldCoupling::Fields::AffineMap< T, codim >::jacobian ( const Utils::Vector3d ,
double  = {} 
) const
inline

Definition at line 55 of file AffineMap.hpp.

◆ operator()()

template<typename T , std::size_t codim>
value_type FieldCoupling::Fields::AffineMap< T, codim >::operator() ( const Utils::Vector3d pos,
double  = {} 
) const
inline

Definition at line 51 of file AffineMap.hpp.


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