JDFTx  1.5.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SpeciesInfo::Constraint Struct Reference

Contains the information on the constraints of motion for each ion. More...

#include <SpeciesInfo.h>

Public Types

enum  ConstraintType { None, Linear, Planar, HyperPlane }
 The direction or plane normal of the constraint (in cartesian coordinates)
 

Public Member Functions

vector3 operator() (const vector3<> &grad) const
 Type of the constraint that is being applied to the ion.
 
bool isEquivalent (const Constraint &otherConstraint, const matrix3<> &transform) const
 
int getDimension () const
 
void print (FILE *fp, const Everything &) const
 

Public Attributes

double moveScale
 
vector3 d
 preconditioning factor (0 fixes ion)
 
enum
SpeciesInfo::Constraint::ConstraintType 
type
 

Detailed Description

Contains the information on the constraints of motion for each ion.


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