olb::opti::projection::ForceFactor< T > Struct Template Reference

Convert force to lattice units. More...

#include <projection.h>

Inheritance diagram for olb::opti::projection::ForceFactor< T >:

Collaboration diagram for olb::opti::projection::ForceFactor< T >:

Public Member Functions
template<typename DESCRIPTOR >
	ForceFactor (const UnitConverter< T, DESCRIPTOR > &converter)
T	project (T x) const override
T	derivative (T x) const override
T	inverse (T x) const override

Public Attributes
const T	scale

Detailed Description

template<typename T>
struct olb::opti::projection::ForceFactor< T >

Convert force to lattice units.

Definition at line 72 of file projection.h.

Constructor & Destructor Documentation

ForceFactor()

template<typename T >

template<typename DESCRIPTOR >

olb::opti::projection::ForceFactor< T >::ForceFactor ( const UnitConverter< T, DESCRIPTOR > & converter )

inline

Definition at line 77 of file projection.h.

   : scale {converter.getConversionFactorMass() / converter.getConversionFactorForce()}
  { }

Member Function Documentation

derivative()

template<typename T >

T olb::opti::projection::ForceFactor< T >::derivative ( T x ) const

inlineoverridevirtual

Implements olb::opti::projection::Base< T >.

Definition at line 82 of file projection.h.

{ return scale; }

References olb::opti::projection::ForceFactor< T >::scale.

inverse()

template<typename T >

T olb::opti::projection::ForceFactor< T >::inverse ( T x ) const

inlineoverridevirtual

Implements olb::opti::projection::Base< T >.

Definition at line 83 of file projection.h.

{ return x / scale; }

References olb::opti::projection::ForceFactor< T >::scale.

project()

template<typename T >

T olb::opti::projection::ForceFactor< T >::project ( T x ) const

inlineoverridevirtual

Implements olb::opti::projection::Base< T >.

Definition at line 81 of file projection.h.

{ return scale * x; }

References olb::opti::projection::ForceFactor< T >::scale.

Member Data Documentation

scale

template<typename T >

const T olb::opti::projection::ForceFactor< T >::scale

Definition at line 74 of file projection.h.

---

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

• src/optimization/projection.h