![]() |
QMCPACK
|
lattice deviation estimator More...
Inheritance diagram for LatticeDeviationEstimator:
Collaboration diagram for LatticeDeviationEstimator:Public Member Functions | |
| LatticeDeviationEstimator (ParticleSet &P, ParticleSet &sP, const std::string &tgroup, const std::string &sgroup) | |
| ~LatticeDeviationEstimator () override | |
| std::string | getClassName () const override |
| return class name More... | |
| bool | put (xmlNodePtr cur) override |
| Read the input parameter. More... | |
| bool | get (std::ostream &os) const override |
| write about the class More... | |
| Return_t | evaluate (ParticleSet &P) override |
| Evaluate the local energy contribution of this component. More... | |
| void | addObservables (PropertySetType &plist, BufferType &collectables) override |
| named values to the property list Default implementaton uses addValue(plist_) More... | |
| void | setObservables (PropertySetType &plist) override |
| Set the values evaluated by this object to plist Default implementation is to assign Value which is updated by evaluate function using my_index_. More... | |
| void | registerCollectables (std::vector< ObservableHelper > &h5desc, hdf_archive &file) const override |
| void | resetTargetParticleSet (ParticleSet &P) override |
| Reset the data with the target ParticleSet. More... | |
| std::unique_ptr< OperatorBase > | makeClone (ParticleSet &qp, TrialWaveFunction &psi) final |
Public Member Functions inherited from OperatorBase | |
| OperatorBase () | |
| Construct a new Operator Base object Default and unique empty constructor. More... | |
| virtual | ~OperatorBase ()=default |
| virtual bool | dependsOnWaveFunction () const |
| return true if this operator depends on a wavefunction More... | |
| std::bitset< 8 > & | getUpdateMode () noexcept |
| get update_mode_ reference More... | |
| Return_t | getValue () const noexcept |
| get a copy of value_ More... | |
| std::string | getName () const noexcept |
| getter a copy of my_name_, rvalue small string optimization More... | |
| void | setName (const std::string name) noexcept |
| Set my_name member, uses small string optimization (pass by value) More... | |
| TraceRequest & | getRequest () noexcept |
| Get request_ member. More... | |
| virtual void | registerObservables (std::vector< ObservableHelper > &h5desc, hdf_archive &file) const |
| add to observable descriptor for hdf5 The default implementation is to register a scalar for this->value_ More... | |
| virtual void | setParticlePropertyList (PropertySetType &plist, int offset) |
| virtual void | setHistories (Walker_t &ThisWalker) |
| virtual Return_t | evaluateDeterministic (ParticleSet &P) |
| Evaluate the local energy contribution of this component, deterministically based on current state. More... | |
| virtual void | mw_evaluate (const RefVectorWithLeader< OperatorBase > &o_list, const RefVectorWithLeader< TrialWaveFunction > &wf_list, const RefVectorWithLeader< ParticleSet > &p_list) const |
| Evaluate the contribution of this component of multiple walkers. More... | |
| virtual void | mw_evaluatePerParticle (const RefVectorWithLeader< OperatorBase > &o_list, const RefVectorWithLeader< TrialWaveFunction > &wf_list, const RefVectorWithLeader< ParticleSet > &p_list, const std::vector< ListenerVector< RealType >> &listeners, const std::vector< ListenerVector< RealType >> &listeners_ions) const |
| Evaluate the contribution of this component of multiple walkers per particle and report to registerd listeners from objects in Estimators. More... | |
| virtual void | mw_evaluateWithParameterDerivatives (const RefVectorWithLeader< OperatorBase > &o_list, const RefVectorWithLeader< ParticleSet > &p_list, const opt_variables_type &optvars, const RecordArray< ValueType > &dlogpsi, RecordArray< ValueType > &dhpsioverpsi) const |
| TODO: add docs. More... | |
| virtual Return_t | rejectedMove (ParticleSet &P) |
| TODO: add docs. More... | |
| virtual Return_t | evaluateWithToperator (ParticleSet &P) |
| Evaluate the local energy contribution of this component with Toperators updated if requested. More... | |
| virtual void | mw_evaluateWithToperator (const RefVectorWithLeader< OperatorBase > &o_list, const RefVectorWithLeader< TrialWaveFunction > &wf_list, const RefVectorWithLeader< ParticleSet > &p_list) const |
| Evaluate the contribution of this component of multiple walkers. More... | |
| virtual void | mw_evaluatePerParticleWithToperator (const RefVectorWithLeader< OperatorBase > &o_list, const RefVectorWithLeader< TrialWaveFunction > &wf_list, const RefVectorWithLeader< ParticleSet > &p_list, const std::vector< ListenerVector< RealType >> &listeners, const std::vector< ListenerVector< RealType >> &listeners_ions) const |
| Evaluate the contribution of this component of multiple walkers per particle and report to registerd listeners from objects in Estimators. More... | |
| virtual Return_t | evaluateValueAndDerivatives (ParticleSet &P, const opt_variables_type &optvars, const Vector< ValueType > &dlogpsi, Vector< ValueType > &dhpsioverpsi) |
| Evaluate value and derivatives wrt the optimizables. More... | |
| virtual Return_t | evaluateWithIonDerivs (ParticleSet &P, ParticleSet &ions, TrialWaveFunction &psi, ParticleSet::ParticlePos &hf_term, ParticleSet::ParticlePos &pulay_term) |
| Evaluate contribution to local energy and derivatives w.r.t ionic coordinates from OperatorBase. More... | |
| virtual Return_t | evaluateWithIonDerivsDeterministic (ParticleSet &P, ParticleSet &ions, TrialWaveFunction &psi, ParticleSet::ParticlePos &hf_term, ParticleSet::ParticlePos &pulay_term) |
| Evaluate contribution to local energy and derivatives w.r.t ionic coordinates from OperatorBase. More... | |
| virtual void | evaluateOneBodyOpMatrix (ParticleSet &P, const TWFFastDerivWrapper &psi, std::vector< ValueMatrix > &B) |
| Evaluate "B" matrix for observable. More... | |
| virtual void | evaluateOneBodyOpMatrixForceDeriv (ParticleSet &P, ParticleSet &source, const TWFFastDerivWrapper &psi, const int iat, std::vector< std::vector< ValueMatrix >> &Bforce) |
| Evaluate "dB/dR" matrices for observable. More... | |
| virtual void | updateSource (ParticleSet &s) |
| Update data associated with a particleset. More... | |
| virtual Return_t | getEnsembleAverage () |
| Return an average value by collective operation. More... | |
| virtual void | createResource (ResourceCollection &collection) const |
| Initialize a shared resource and hand it to a collection. More... | |
| virtual void | acquireResource (ResourceCollection &collection, const RefVectorWithLeader< OperatorBase > &o_list) const |
| Acquire a shared resource from a collection. More... | |
| virtual void | releaseResource (ResourceCollection &collection, const RefVectorWithLeader< OperatorBase > &o_list) const |
| Return a shared resource to a collection. More... | |
| virtual void | setRandomGenerator (RandomBase< FullPrecRealType > *rng) |
| Set the Random Generator object TODO: add docs. More... | |
| virtual void | add2Hamiltonian (ParticleSet &qp, TrialWaveFunction &psi, QMCHamiltonian &targetH) |
| TODO: add docs. More... | |
| virtual void | getRequiredTraces (TraceManager &tm) |
| TODO: add docs. More... | |
| virtual void | informOfPerParticleListener () |
| bool | isClassical () const noexcept |
| bool | isQuantum () const noexcept |
| bool | isClassicalClassical () const noexcept |
| bool | isQuantumClassical () const noexcept |
| bool | isQuantumQuantum () const noexcept |
| bool | getMode (const int i) const noexcept |
| Return the mode i. More... | |
| bool | isNonLocal () const noexcept |
| TODO: add docs. More... | |
| bool | hasListener () const noexcept |
| void | contributeTraceQuantities () |
| Make trace quantities available. More... | |
| void | checkoutTraceQuantities (TraceManager &tm) |
| Checkout trace arrays Derived classes must guard individual checkouts using request info. More... | |
| void | collectScalarTraces () |
| Collect scalar trace data. More... | |
| void | deleteTraceQuantities () |
| delete trace arrays More... | |
Private Attributes | |
| SpeciesSet & | tspecies |
| SpeciesSet & | sspecies |
| ParticleSet & | tpset |
| ParticleSet | spset |
| std::string | tgroup |
| std::string | sgroup |
| int | num_sites |
| bool | hdf5_out |
| int | h5_index |
| bool | per_xyz |
| std::vector< RealType > | xyz2 |
| xmlNodePtr | input_xml |
| const int | myTableID_ |
Additional Inherited Members | |
Public Types inherited from OperatorBase | |
| enum | EnergyDomains { KINETIC = 0, POTENTIAL, NO_ENERGY_DOMAIN } |
| enum to denote energy domain of operators More... | |
| enum | QuantumDomains { NO_QUANTUM_DOMAIN = 0, CLASSICAL, QUANTUM, CLASSICAL_CLASSICAL, QUANTUM_CLASSICAL, QUANTUM_QUANTUM } |
| enum | { PRIMARY = 0, OPTIMIZABLE = 1, RATIOUPDATE = 2, PHYSICAL = 3, COLLECTABLE = 4, NONLOCAL = 5 } |
| enum for update_mode More... | |
| using | Return_t = FullPrecRealType |
| type of return value of evaluate More... | |
| using | ValueMatrix = SPOSet::ValueMatrix |
| For fast derivative evaluation. More... | |
| using | GradMatrix = SPOSet::GradMatrix |
| using | BufferType = ParticleSet::Buffer_t |
| typedef for the serialized buffer More... | |
| using | Walker_t = ParticleSet::Walker_t |
| typedef for the walker More... | |
| using | ParticleScalar = ParticleSet::Scalar_t |
| typedef for the ParticleScalar More... | |
| using | SPOMap = SPOSet::SPOMap |
| typedef for SPOMap More... | |
Public Types inherited from QMCTraits | |
| enum | { DIM = OHMMS_DIM, DIM_VGL = OHMMS_DIM + 2 } |
| using | QTBase = QMCTypes< OHMMS_PRECISION, DIM > |
| using | QTFull = QMCTypes< OHMMS_PRECISION_FULL, DIM > |
| using | RealType = QTBase::RealType |
| using | ComplexType = QTBase::ComplexType |
| using | ValueType = QTBase::ValueType |
| using | PosType = QTBase::PosType |
| using | GradType = QTBase::GradType |
| using | TensorType = QTBase::TensorType |
| using | IndexType = OHMMS_INDEXTYPE |
| define other types More... | |
| using | FullPrecRealType = QTFull::RealType |
| using | FullPrecValueType = QTFull::ValueType |
| using | PropertySetType = RecordNamedProperty< FullPrecRealType > |
| define PropertyList_t More... | |
| using | PtclGrpIndexes = std::vector< std::pair< int, int > > |
Protected Member Functions inherited from OperatorBase | |
| virtual void | contributeScalarQuantities () |
| virtual void | checkoutScalarQuantities (TraceManager &tm) |
| virtual void | collectScalarQuantities () |
| virtual void | deleteScalarQuantities () |
| virtual void | contributeParticleQuantities () |
| virtual void | checkoutParticleQuantities (TraceManager &tm) |
| virtual void | deleteParticleQuantities () |
| virtual void | setComputeForces (bool compute) |
| void | setEnergyDomain (EnergyDomains edomain) |
| Set the Energy Domain. More... | |
| void | setQuantumDomain (QuantumDomains qdomain) |
| set quantum domain More... | |
| void | oneBodyQuantumDomain (const ParticleSet &P) |
| set quantum domain for one-body operator More... | |
| void | twoBodyQuantumDomain (const ParticleSet &P) |
| set quantum domain for two-body operator More... | |
| void | twoBodyQuantumDomain (const ParticleSet &P1, const ParticleSet &P2) |
| set quantum domain for two-body operator More... | |
| void | addValue (PropertySetType &plist) |
| named values to the property list More... | |
Protected Attributes inherited from OperatorBase | |
| std::bitset< 8 > | update_mode_ |
| set the current update mode More... | |
| Return_t | value_ |
| current value More... | |
| std::string | name_ |
| name of this object More... | |
| TraceRequest | request_ |
| whether traces are being collected More... | |
| int | my_index_ |
| starting index of this object More... | |
| Return_t | new_value_ |
| a new value for a proposed move More... | |
| Walker_t * | t_walker_ |
| reference to the current walker More... | |
| bool | streaming_particles_ |
| bool | have_required_traces_ |
lattice deviation estimator
Compute deviation of species="tgroup" in target particle set from species="sgroup" in source particle set. The motivation is to observe the deviation of protons from their crystal sites in an all electron-proton simulation of hydrogen i.e. two-component system One can also create any reference point to measure the deviation of an up electron, for example <particleset name="wf_center"> <group name="origin" size="1"> <attrib name="position" datatype="posArray" condition="0"> 0.00000000 0.00000000 0.00000000 </attrib> </group> </particleset> <estimator type="latticedeviation" name="latdev" hdf5="yes" per_xyz="yes" source="wf_center" sgroup="origin" target="e" tgroup="u"> This estimator outputs to both scalar.dat and stat.h5. The scalar.dat entries are averaged over all particles, whereas the stat.h5 entries are particle-resolved. The two sets of outputs can be compared as a consistency check for the estimator.
Definition at line 39 of file LatticeDeviationEstimator.h.
| LatticeDeviationEstimator | ( | ParticleSet & | P, |
| ParticleSet & | sP, | ||
| const std::string & | tgroup, | ||
| const std::string & | sgroup | ||
| ) |
Definition at line 17 of file LatticeDeviationEstimator.cpp.
References APP_ABORT, qmcplusplus::app_log(), SpeciesSet::findSpecies(), ParticleSet::first(), ParticleSet::last(), LatticeDeviationEstimator::num_sites, LatticeDeviationEstimator::sgroup, LatticeDeviationEstimator::spset, LatticeDeviationEstimator::sspecies, LatticeDeviationEstimator::tgroup, LatticeDeviationEstimator::tpset, and LatticeDeviationEstimator::tspecies.
|
inlineoverride |
Definition at line 43 of file LatticeDeviationEstimator.h.
|
overridevirtual |
named values to the property list Default implementaton uses addValue(plist_)
| plist | RecordNameProperty |
| collectables | Observables that are accumulated by evaluate |
Reimplemented from OperatorBase.
Definition at line 169 of file LatticeDeviationEstimator.cpp.
References PooledData< T >::add(), RecordNamedProperty< T >::add(), LatticeDeviationEstimator::h5_index, LatticeDeviationEstimator::hdf5_out, OperatorBase::my_index_, OperatorBase::name_, LatticeDeviationEstimator::num_sites, OHMMS_DIM, LatticeDeviationEstimator::per_xyz, PooledData< T >::size(), and RecordNamedProperty< T >::size().
|
overridevirtual |
Evaluate the local energy contribution of this component.
| P | input configuration containing N particles |
Implements OperatorBase.
Definition at line 96 of file LatticeDeviationEstimator.cpp.
References APP_ABORT, qmcplusplus::app_log(), ParticleSet::Collectables, ParticleSet::getDistTableAB(), ParticleSet::getTotalNum(), ParticleSet::GroupID, LatticeDeviationEstimator::h5_index, LatticeDeviationEstimator::hdf5_out, LatticeDeviationEstimator::myTableID_, LatticeDeviationEstimator::num_sites, OHMMS_DIM, LatticeDeviationEstimator::per_xyz, LatticeDeviationEstimator::sgroup, SpeciesSet::speciesName, LatticeDeviationEstimator::spset, LatticeDeviationEstimator::sspecies, OperatorBase::t_walker_, LatticeDeviationEstimator::tgroup, LatticeDeviationEstimator::tpset, LatticeDeviationEstimator::tspecies, OperatorBase::value_, Walker< t_traits, p_traits >::Weight, and LatticeDeviationEstimator::xyz2.
|
overridevirtual |
write about the class
Implements OperatorBase.
Definition at line 90 of file LatticeDeviationEstimator.cpp.
References OhmmsElementBase::getName(), OperatorBase::name_, and LatticeDeviationEstimator::spset.
|
inlineoverridevirtual |
return class name
Implements OperatorBase.
Definition at line 45 of file LatticeDeviationEstimator.h.
|
finalvirtual |
Implements OperatorBase.
Definition at line 218 of file LatticeDeviationEstimator.cpp.
References LatticeDeviationEstimator::input_xml, LatticeDeviationEstimator::sgroup, LatticeDeviationEstimator::spset, and LatticeDeviationEstimator::tgroup.
|
overridevirtual |
Read the input parameter.
| cur | xml node for a OperatorBase object |
Implements OperatorBase.
Definition at line 44 of file LatticeDeviationEstimator.cpp.
References OhmmsAttributeSet::add(), APP_ABORT, OperatorBase::COLLECTABLE, LatticeDeviationEstimator::hdf5_out, LatticeDeviationEstimator::input_xml, OHMMS_DIM, LatticeDeviationEstimator::per_xyz, OhmmsAttributeSet::put(), OperatorBase::update_mode_, and LatticeDeviationEstimator::xyz2.
|
overridevirtual |
Reimplemented from OperatorBase.
Definition at line 228 of file LatticeDeviationEstimator.cpp.
References LatticeDeviationEstimator::h5_index, LatticeDeviationEstimator::hdf5_out, OperatorBase::name_, LatticeDeviationEstimator::num_sites, OHMMS_DIM, and LatticeDeviationEstimator::per_xyz.
|
overridevirtual |
Reset the data with the target ParticleSet.
| P | new target ParticleSet |
Implements OperatorBase.
Definition at line 216 of file LatticeDeviationEstimator.cpp.
|
overridevirtual |
Set the values evaluated by this object to plist Default implementation is to assign Value which is updated by evaluate function using my_index_.
| plist | RecordNameProperty |
Reimplemented from OperatorBase.
Definition at line 204 of file LatticeDeviationEstimator.cpp.
References RecordNamedProperty< T >::begin(), copy(), OperatorBase::my_index_, LatticeDeviationEstimator::per_xyz, OperatorBase::value_, and LatticeDeviationEstimator::xyz2.
|
private |
Definition at line 71 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::addObservables(), LatticeDeviationEstimator::evaluate(), and LatticeDeviationEstimator::registerCollectables().
|
private |
Definition at line 70 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::addObservables(), LatticeDeviationEstimator::evaluate(), LatticeDeviationEstimator::put(), and LatticeDeviationEstimator::registerCollectables().
|
private |
Definition at line 74 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::makeClone(), and LatticeDeviationEstimator::put().
|
private |
Definition at line 76 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::evaluate().
|
private |
Definition at line 69 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::addObservables(), LatticeDeviationEstimator::evaluate(), LatticeDeviationEstimator::LatticeDeviationEstimator(), and LatticeDeviationEstimator::registerCollectables().
|
private |
|
private |
Definition at line 68 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::evaluate(), LatticeDeviationEstimator::LatticeDeviationEstimator(), and LatticeDeviationEstimator::makeClone().
|
private |
Definition at line 67 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::evaluate(), LatticeDeviationEstimator::get(), LatticeDeviationEstimator::LatticeDeviationEstimator(), and LatticeDeviationEstimator::makeClone().
|
private |
Definition at line 66 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::evaluate(), and LatticeDeviationEstimator::LatticeDeviationEstimator().
|
private |
Definition at line 68 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::evaluate(), LatticeDeviationEstimator::LatticeDeviationEstimator(), and LatticeDeviationEstimator::makeClone().
|
private |
Definition at line 67 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::evaluate(), and LatticeDeviationEstimator::LatticeDeviationEstimator().
|
private |
Definition at line 65 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::evaluate(), and LatticeDeviationEstimator::LatticeDeviationEstimator().
|
private |
Definition at line 73 of file LatticeDeviationEstimator.h.
Referenced by LatticeDeviationEstimator::evaluate(), LatticeDeviationEstimator::put(), and LatticeDeviationEstimator::setObservables().