![]() |
QMCPACK
|
SkEstimator evaluate the structure factor of the target particleset. More...
Inheritance diagram for SkEstimator:
Collaboration diagram for SkEstimator:Public Member Functions | |
| SkEstimator (ParticleSet &elns) | |
| std::string | getClassName () const override |
| return class name More... | |
| void | resetTargetParticleSet (ParticleSet &P) override |
| Reset the data with the target ParticleSet. More... | |
| Return_t | evaluate (ParticleSet &P) override |
| Evaluate the local energy contribution of this component. More... | |
| void | addObservables (PropertySetType &plist) |
| void | addObservables (PropertySetType &plist, BufferType &collectables) override |
| named values to the property list Default implementaton uses addValue(plist_) More... | |
| void | registerCollectables (std::vector< ObservableHelper > &h5desc, hdf_archive &file) const override |
| 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 | setParticlePropertyList (PropertySetType &plist, int offset) override |
| bool | put (xmlNodePtr cur) override |
| Read the input parameter. More... | |
| bool | get (std::ostream &os) const override |
| write about the class More... | |
| std::unique_ptr< OperatorBase > | makeClone (ParticleSet &qp, TrialWaveFunction &psi) override |
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 | 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... | |
Protected Member Functions | |
| void | resize () |
| resize the internal data More... | |
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 | |
| ParticleSet * | sourcePtcl |
| int | NumSpecies |
| number of species More... | |
| int | NumK |
| number of kpoints More... | |
| int | MaxKshell |
| number of kshells More... | |
| RealType | OneOverN |
| normalization factor More... | |
| std::vector< int > | Kshell |
| kshell counters More... | |
| std::vector< RealType > | Kmag |
| instantaneous structure factor More... | |
| std::vector< RealType > | OneOverDnk |
| 1.0/degenracy for a ksell More... | |
| Vector< RealType > | RhokTot_r |
for species index More... | |
| Vector< RealType > | RhokTot_i |
| Vector< RealType > | values |
| bool | hdf5_out |
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_ |
SkEstimator evaluate the structure factor of the target particleset.
<estimator name="sk" type="sk" debug="no">
Definition at line 28 of file SkEstimator.h.
| SkEstimator | ( | ParticleSet & | elns | ) |
Definition at line 23 of file SkEstimator.cpp.
References OperatorBase::COLLECTABLE, ParticleSet::getSimulationCell(), ParticleSet::getSpeciesSet(), SpeciesSet::getTotalNum(), ParticleSet::getTotalNum(), SkEstimator::hdf5_out, SkEstimator::Kmag, SkEstimator::Kshell, SkEstimator::MaxKshell, SkEstimator::NumK, SkEstimator::NumSpecies, SkEstimator::OneOverDnk, SkEstimator::OneOverN, Vector< T, Alloc >::resize(), SkEstimator::RhokTot_i, SkEstimator::RhokTot_r, SkEstimator::sourcePtcl, qmcplusplus::sqrt(), OperatorBase::update_mode_, and SkEstimator::values.
| void addObservables | ( | PropertySetType & | plist | ) |
Definition at line 93 of file SkEstimator.cpp.
References RecordNamedProperty< T >::add(), OperatorBase::my_index_, SkEstimator::NumK, and RecordNamedProperty< T >::size().
|
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 73 of file SkEstimator.cpp.
References PooledData< T >::add(), RecordNamedProperty< T >::add(), SkEstimator::hdf5_out, OperatorBase::my_index_, SkEstimator::NumK, 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 47 of file SkEstimator.cpp.
References qmcplusplus::accumulate_elements(), Vector< T, Alloc >::begin(), ParticleSet::Collectables, copy(), Vector< T, Alloc >::end(), ParticleSet::getSK(), SkEstimator::hdf5_out, OperatorBase::my_index_, SkEstimator::NumK, SkEstimator::NumSpecies, SkEstimator::OneOverN, StructFact::rhok_i, StructFact::rhok_r, SkEstimator::RhokTot_i, SkEstimator::RhokTot_r, and SkEstimator::values.
|
overridevirtual |
|
inlineoverridevirtual |
|
overridevirtual |
Implements OperatorBase.
Definition at line 158 of file SkEstimator.cpp.
References SkEstimator::hdf5_out, and OperatorBase::my_index_.
|
overridevirtual |
Read the input parameter.
| cur | xml node for a OperatorBase object |
Implements OperatorBase.
Definition at line 143 of file SkEstimator.cpp.
References OhmmsAttributeSet::add(), SkEstimator::hdf5_out, and OhmmsAttributeSet::put().
|
overridevirtual |
Reimplemented from OperatorBase.
Definition at line 117 of file SkEstimator.cpp.
References hdf_archive::flush(), hdf_archive::getFileID(), ParticleSet::getSimulationCell(), SkEstimator::hdf5_out, OperatorBase::my_index_, OperatorBase::name_, SkEstimator::NumK, OHMMS_DIM, and SkEstimator::sourcePtcl.
|
overridevirtual |
Reset the data with the target ParticleSet.
| P | new target ParticleSet |
Implements OperatorBase.
Definition at line 45 of file SkEstimator.cpp.
References SkEstimator::sourcePtcl.
|
protected |
resize the internal data
The argument list is not completed
|
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 104 of file SkEstimator.cpp.
References RecordNamedProperty< T >::begin(), Vector< T, Alloc >::begin(), copy(), Vector< T, Alloc >::end(), SkEstimator::hdf5_out, OperatorBase::my_index_, and SkEstimator::values.
|
overridevirtual |
Reimplemented from OperatorBase.
Definition at line 110 of file SkEstimator.cpp.
References RecordNamedProperty< T >::begin(), Vector< T, Alloc >::begin(), copy(), Vector< T, Alloc >::end(), SkEstimator::hdf5_out, OperatorBase::my_index_, and SkEstimator::values.
|
protected |
Definition at line 72 of file SkEstimator.h.
Referenced by SkEstimator::addObservables(), SkEstimator::evaluate(), SkEstimator::makeClone(), SkEstimator::put(), SkEstimator::registerCollectables(), SkEstimator::setObservables(), SkEstimator::setParticlePropertyList(), and SkEstimator::SkEstimator().
|
protected |
instantaneous structure factor
Definition at line 60 of file SkEstimator.h.
Referenced by SkEstimator::SkEstimator().
|
protected |
kshell counters
Definition at line 58 of file SkEstimator.h.
Referenced by SkEstimator::SkEstimator().
|
protected |
number of kshells
Definition at line 54 of file SkEstimator.h.
Referenced by SkEstimator::SkEstimator().
|
protected |
number of kpoints
Definition at line 52 of file SkEstimator.h.
Referenced by SkEstimator::addObservables(), SkEstimator::evaluate(), SkEstimator::registerCollectables(), and SkEstimator::SkEstimator().
|
protected |
number of species
Definition at line 50 of file SkEstimator.h.
Referenced by SkEstimator::evaluate(), and SkEstimator::SkEstimator().
|
protected |
1.0/degenracy for a ksell
Definition at line 62 of file SkEstimator.h.
Referenced by SkEstimator::SkEstimator().
|
protected |
normalization factor
Definition at line 56 of file SkEstimator.h.
Referenced by SkEstimator::evaluate(), and SkEstimator::SkEstimator().
Definition at line 64 of file SkEstimator.h.
Referenced by SkEstimator::evaluate(), and SkEstimator::SkEstimator().
for species index
Definition at line 64 of file SkEstimator.h.
Referenced by SkEstimator::evaluate(), and SkEstimator::SkEstimator().
|
protected |
Definition at line 48 of file SkEstimator.h.
Referenced by SkEstimator::registerCollectables(), SkEstimator::resetTargetParticleSet(), and SkEstimator::SkEstimator().
Definition at line 65 of file SkEstimator.h.
Referenced by SkEstimator::evaluate(), SkEstimator::setObservables(), SkEstimator::setParticlePropertyList(), and SkEstimator::SkEstimator().