Loading...
Searching...
No Matches
eonc::ZBLRepulsiveIDPPObjective Class Reference

#include <IDPPObjectiveFunction.hpp>

Inheritance diagram for eonc::ZBLRepulsiveIDPPObjective:

Public Member Functions

 ZBLRepulsiveIDPPObjective (std::shared_ptr< ObjectiveFunction > idpp, std::shared_ptr< Potential > zbl, std::vector< Matter > &p, const Parameters &params, double weight=1.0)
double getEnergy () override
VectorXd getGradient (bool fdstep=false) override
void setPositions (const VectorXd &x) override
VectorXd getPositions () override
int degreesOfFreedom () override
bool isConverged () override
double getConvergence () override
VectorXd difference (const VectorXd &a, const VectorXd &b) override
Public Member Functions inherited from eonc::ObjectiveFunction
 ObjectiveFunction (const Parameters &paramsPassed)
virtual ~ObjectiveFunction ()
virtual bool supportsFiniteDifferenceCurvature () const
virtual bool gradientMatchesEnergy () const
virtual bool pastClimbCeiling ()
virtual bool reuseDisplacementCurvature () const
virtual std::optional< double > knownCurvature () const
virtual void minimumImage (Eigen::Ref< Eigen::Vector3d >) const
virtual VectorXd getMasses () const
virtual bool getPeriodic () const

Public Attributes

std::shared_ptr< ObjectiveFunction > idpp_obj
std::shared_ptr< Potential > zbl_pot
std::vector< Matter > & path
double zbl_weight

Additional Inherited Members

Protected Attributes inherited from eonc::ObjectiveFunction
const Parameters & params

Detailed Description

Definition at line 139 of file IDPPObjectiveFunction.hpp.

Constructor & Destructor Documentation

◆ ZBLRepulsiveIDPPObjective()

eonc::ZBLRepulsiveIDPPObjective::ZBLRepulsiveIDPPObjective ( std::shared_ptr< ObjectiveFunction > idpp,
std::shared_ptr< Potential > zbl,
std::vector< Matter > & p,
const Parameters & params,
double weight = 1.0 )
inline

Definition at line 146 of file IDPPObjectiveFunction.hpp.

150 : ObjectiveFunction(params), idpp_obj(idpp), zbl_pot(zbl), path(p),
151 zbl_weight(weight) {}
ObjectiveFunction(const Parameters &paramsPassed)
const Parameters & params
std::shared_ptr< Potential > zbl_pot
std::shared_ptr< ObjectiveFunction > idpp_obj

Member Function Documentation

◆ degreesOfFreedom()

int eonc::ZBLRepulsiveIDPPObjective::degreesOfFreedom ( )
inlineoverridevirtual

Implements eonc::ObjectiveFunction.

Definition at line 194 of file IDPPObjectiveFunction.hpp.

194{ return idpp_obj->degreesOfFreedom(); }

◆ difference()

VectorXd eonc::ZBLRepulsiveIDPPObjective::difference ( const VectorXd & a,
const VectorXd & b )
inlineoverridevirtual

Implements eonc::ObjectiveFunction.

Definition at line 198 of file IDPPObjectiveFunction.hpp.

198 {
199 return idpp_obj->difference(a, b);
200 }

◆ getConvergence()

double eonc::ZBLRepulsiveIDPPObjective::getConvergence ( )
inlineoverridevirtual

Implements eonc::ObjectiveFunction.

Definition at line 196 of file IDPPObjectiveFunction.hpp.

196{ return idpp_obj->getConvergence(); }

◆ getEnergy()

double eonc::ZBLRepulsiveIDPPObjective::getEnergy ( )
inlineoverridevirtual

Implements eonc::ObjectiveFunction.

Definition at line 153 of file IDPPObjectiveFunction.hpp.

153 {
154 // IDPP "Energy" (Residual) + ZBL Energy
155 return idpp_obj->getEnergy();
156 }

◆ getGradient()

VectorXd eonc::ZBLRepulsiveIDPPObjective::getGradient ( bool fdstep = false)
inlineoverridevirtual

Implements eonc::ObjectiveFunction.

Definition at line 158 of file IDPPObjectiveFunction.hpp.

158 {
159 // 1. Get IDPP Gradient (forces atoms towards interpolated distances)
160 VectorXd grad = idpp_obj->getGradient(fdstep);
161
162 // 2. Calculate ZBL Forces for every image
163 int n_images = path.size();
164 int atoms_per_image = path[0].numberOfAtoms();
165
166 const int nfree = static_cast<int>(path[0].numberOfFreeAtoms());
167 const int seg = 3 * nfree;
168 for (int i = 1; i < n_images - 1; ++i) {
169 AtomMatrix forces = MatrixXd::Zero(atoms_per_image, 3);
170 double energy = 0;
171
172 zbl_pot->force(atoms_per_image, path[i].getPositions().data(),
173 path[i].getAtomicNrs().data(), forces.data(), &energy,
174 nullptr, path[i].getCell().data());
175
176 VectorXd zbl_free(seg);
177 long k = 0;
178 for (int a = 0; a < atoms_per_image; ++a) {
179 if (!path[i].getFixed(a)) {
180 zbl_free[k++] = forces(a, 0);
181 zbl_free[k++] = forces(a, 1);
182 zbl_free[k++] = forces(a, 2);
183 }
184 }
185 grad.segment((i - 1) * seg, seg) -= (zbl_free * zbl_weight);
186 }
187
188 return grad;
189 }
Eigen::Matrix< double, Eigen::Dynamic, 3, eOnStorageOrder > AtomMatrix
Definition Eigen.h:37

◆ getPositions()

VectorXd eonc::ZBLRepulsiveIDPPObjective::getPositions ( )
inlineoverridevirtual

Implements eonc::ObjectiveFunction.

Definition at line 193 of file IDPPObjectiveFunction.hpp.

193{ return idpp_obj->getPositions(); }

◆ isConverged()

bool eonc::ZBLRepulsiveIDPPObjective::isConverged ( )
inlineoverridevirtual

Implements eonc::ObjectiveFunction.

Definition at line 195 of file IDPPObjectiveFunction.hpp.

195{ return idpp_obj->isConverged(); }

◆ setPositions()

void eonc::ZBLRepulsiveIDPPObjective::setPositions ( const VectorXd & x)
inlineoverridevirtual

Implements eonc::ObjectiveFunction.

Definition at line 192 of file IDPPObjectiveFunction.hpp.

192{ idpp_obj->setPositions(x); }

Member Data Documentation

◆ idpp_obj

std::shared_ptr<ObjectiveFunction> eonc::ZBLRepulsiveIDPPObjective::idpp_obj

Definition at line 141 of file IDPPObjectiveFunction.hpp.

◆ path

std::vector<Matter>& eonc::ZBLRepulsiveIDPPObjective::path

Definition at line 143 of file IDPPObjectiveFunction.hpp.

◆ zbl_pot

std::shared_ptr<Potential> eonc::ZBLRepulsiveIDPPObjective::zbl_pot

Definition at line 142 of file IDPPObjectiveFunction.hpp.

◆ zbl_weight

double eonc::ZBLRepulsiveIDPPObjective::zbl_weight

Definition at line 144 of file IDPPObjectiveFunction.hpp.


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