Clipper
Public Member Functions | List of all members
clipper::Grad_map< T > Class Template Reference

map coordinate gradient, with respect to grid u,v,w More...

#include <derivs.h>

Inheritance diagram for clipper::Grad_map< T >:
clipper::Vec3< T >

Public Member Functions

 Grad_map ()
 null constructor
 
 Grad_map (const Vec3< T > &v)
 constructor: copy/convert
 
 Grad_map (const T &du, const T &dv, const T &dw)
 constructor: from d/du,d/dv,d/dw
 
const T & du () const
 get d/du
 
const T & dv () const
 get d/dv
 
const T & dw () const
 get d/dw
 
Grad_frac< T > grad_frac (const Grid &g) const
 grid-fractional derivative conversion More...
 
String format () const
 return formatted String representation More...
 
- Public Member Functions inherited from clipper::Vec3< T >
 Vec3 ()
 null constructor
 
 Vec3 (const T &v0, const T &v1, const T &v2)
 constructor: from individual values
 
template<class TT >
 Vec3 (const Vec3< TT > &v)
 constructor: copy/convert
 
bool equals (const Vec3< T > &v, const T &tol) const
 test equality
 
const T & operator[] (const int &i) const
 get element
 
T & operator[] (const int &i)
 set element
 
Vec3< T > unit () const
 return unit vector with same direction as this vector
 
bool is_null () const
 test for null vector
 
String format () const
 return formatted String representation
 
const Vec3< T > & operator+= (const Vec3< T > &v)
 add another vector to this one
 
const Vec3< T > & operator-= (const Vec3< T > &v)
 subtract another vector from this one
 

Additional Inherited Members

- Static Public Member Functions inherited from clipper::Vec3< T >
static Vec3< T > zero ()
 return zero vector
 
static Vec3< T > null ()
 return null vector (only valid for floating point types)
 
static T dot (const Vec3< T > &v1, const Vec3< T > &v2)
 Vector dot product (equivalent to *)
 
static Vec3< T > cross (const Vec3< T > &v1, const Vec3< T > &v2)
 Vector cross product.
 

Detailed Description

template<class T>
class clipper::Grad_map< T >

map coordinate gradient, with respect to grid u,v,w

Member Function Documentation

template<class T >
Grad_frac< T > clipper::Grad_map< T >::grad_frac ( const Grid g) const
inline

grid-fractional derivative conversion

Parameters
gThe grid concerned
Returns
The transformed derivative.
template<class T >
String clipper::Grad_map< T >::format ( ) const

return formatted String representation

Returns
The formatted text string

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