CHROMA
Public Member Functions | Private Attributes | List of all members

Differentiable M^dag linear operator. More...

#include <ldag.h>

Inheritance diagram for Chroma::DiffMdagLinOp< T, P, Q >:
Chroma::DiffLinearOperator< T, P, Q > Chroma::LinearOperator< T >

Public Member Functions

 DiffMdagLinOp (DiffLinearOperator< T, P, Q > *p)
 Initialize pointer with existing pointer. More...
 
 DiffMdagLinOp (Handle< DiffLinearOperator< T, P, Q > > p)
 Copy pointer (one more owner) More...
 
 ~DiffMdagLinOp ()
 Destructor. More...
 
const FermBC< T, P, Q > & getFermBC () const
 Return the fermion BC object for this linear operator. More...
 
const Subset & subset () const
 Subset comes from underlying operator. More...
 
void operator() (T &chi, const T &psi, enum PlusMinus isign) const
 Apply the operator onto a source std::vector. More...
 
virtual void deriv (P &ds_u, const T &chi, const T &psi, enum PlusMinus isign) const
 Apply the derivative of the operator. More...
 
virtual void deriv (P &ds_u, const T &chi, const T &psi, enum PlusMinus isign, const Real &epsilon) const
 Apply the derivative of the operator. More...
 
unsigned long nFlops (void) const
 Return the number of flops performed by operator() More...
 
- Public Member Functions inherited from Chroma::DiffLinearOperator< T, P, Q >
virtual ~DiffLinearOperator ()
 Virtual destructor to help with cleanup;. More...
 
virtual void derivMultipole (P &ds_u, const multi1d< T > &chi, const multi1d< T > &psi, enum PlusMinus isign) const
 Return the force for multiple poles. More...
 
- Public Member Functions inherited from Chroma::LinearOperator< T >
virtual ~LinearOperator ()
 Virtual destructor to help with cleanup;. More...
 
virtual void operator() (T &chi, const T &psi, enum PlusMinus isign, Real epsilon) const
 Apply the operator onto a source std::vector to some precision. More...
 

Private Attributes

Handle< DiffLinearOperator< T, P, Q > > A
 

Detailed Description

template<typename T, typename P, typename Q>
class Chroma::DiffMdagLinOp< T, P, Q >

Differentiable M^dag linear operator.

Diff. Linear operator forming M^dag from an operator M

Definition at line 160 of file ldag.h.

Constructor & Destructor Documentation

◆ DiffMdagLinOp() [1/2]

template<typename T , typename P , typename Q >
Chroma::DiffMdagLinOp< T, P, Q >::DiffMdagLinOp ( DiffLinearOperator< T, P, Q > *  p)
inline

Initialize pointer with existing pointer.

Requires that the pointer p is a return value of new

Definition at line 165 of file ldag.h.

◆ DiffMdagLinOp() [2/2]

template<typename T , typename P , typename Q >
Chroma::DiffMdagLinOp< T, P, Q >::DiffMdagLinOp ( Handle< DiffLinearOperator< T, P, Q > >  p)
inline

Copy pointer (one more owner)

Definition at line 168 of file ldag.h.

◆ ~DiffMdagLinOp()

template<typename T , typename P , typename Q >
Chroma::DiffMdagLinOp< T, P, Q >::~DiffMdagLinOp ( )
inline

Destructor.

Definition at line 171 of file ldag.h.

Member Function Documentation

◆ deriv() [1/2]

template<typename T , typename P , typename Q >
virtual void Chroma::DiffMdagLinOp< T, P, Q >::deriv ( P ds_u,
const T chi,
const T psi,
enum PlusMinus  isign 
) const
inlinevirtual

Apply the derivative of the operator.

Deriv of chi^dag * A^dag * psi

Default implementation

Reimplemented from Chroma::DiffLinearOperator< T, P, Q >.

Definition at line 195 of file ldag.h.

References Chroma::DiffMdagLinOp< T, P, Q >::A, Chroma::chi(), Chroma::isign, Chroma::MINUS, Chroma::PLUS, Chroma::psi, and Chroma::tmp.

◆ deriv() [2/2]

template<typename T , typename P , typename Q >
virtual void Chroma::DiffMdagLinOp< T, P, Q >::deriv ( P ds_u,
const T chi,
const T psi,
enum PlusMinus  isign,
const Real &  epsilon 
) const
inlinevirtual

Apply the derivative of the operator.

Deriv of chi^dag * A^dag * psi

Default implementation

Reimplemented from Chroma::DiffLinearOperator< T, P, Q >.

Definition at line 211 of file ldag.h.

References Chroma::DiffMdagLinOp< T, P, Q >::A, Chroma::chi(), Chroma::ExternalFieldEnv::epsilon(), Chroma::isign, Chroma::MINUS, Chroma::PLUS, Chroma::psi, and Chroma::tmp.

◆ getFermBC()

template<typename T , typename P , typename Q >
const FermBC<T,P,Q>& Chroma::DiffMdagLinOp< T, P, Q >::getFermBC ( ) const
inlinevirtual

Return the fermion BC object for this linear operator.

Implements Chroma::DiffLinearOperator< T, P, Q >.

Definition at line 174 of file ldag.h.

References Chroma::DiffMdagLinOp< T, P, Q >::A.

◆ nFlops()

template<typename T , typename P , typename Q >
unsigned long Chroma::DiffMdagLinOp< T, P, Q >::nFlops ( void  ) const
inlinevirtual

Return the number of flops performed by operator()

Reimplemented from Chroma::LinearOperator< T >.

Definition at line 221 of file ldag.h.

References Chroma::DiffMdagLinOp< T, P, Q >::A.

◆ operator()()

template<typename T , typename P , typename Q >
void Chroma::DiffMdagLinOp< T, P, Q >::operator() ( T chi,
const T psi,
enum PlusMinus  isign 
) const
inlinevirtual

Apply the operator onto a source std::vector.

For this operator, the sign is ignored

Implements Chroma::LinearOperator< T >.

Definition at line 181 of file ldag.h.

References Chroma::chi(), Chroma::isign, Chroma::MINUS, Chroma::PLUS, Chroma::psi, and Chroma::tmp.

◆ subset()

template<typename T , typename P , typename Q >
const Subset& Chroma::DiffMdagLinOp< T, P, Q >::subset ( void  ) const
inlinevirtual

Subset comes from underlying operator.

Implements Chroma::LinearOperator< T >.

Definition at line 177 of file ldag.h.

References Chroma::DiffMdagLinOp< T, P, Q >::A.

Member Data Documentation

◆ A

template<typename T , typename P , typename Q >
Handle< DiffLinearOperator<T,P,Q> > Chroma::DiffMdagLinOp< T, P, Q >::A
private

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