Implements the function f = A*r/(B*r + 1) - A/B. More...

Inheritance diagram for UserFunctor< T >:

Collaboration diagram for UserFunctor< T >:

Public Member Functions
	UserFunctor (const std::string &my_name)
	default constructor More...

void	setCusp (real_type cusp) override
	empty virtual function to help builder classes More...

OptimizableFunctorBase *	makeClone () const override
	create a clone of this object More...

void	reset () override
	reset function More...

real_type	evaluate (real_type r) const

real_type	evaluate (real_type r, real_type &dudr, real_type &d2udr2) const

real_type	evaluate (real_type r, real_type &dudr, real_type &d2udr2, real_type &d3udr3) const

real_type	evaluateV (const int iat, const int iStart, const int iEnd, const T restrict _distArray, T restrict distArrayCompressed) const

void	evaluateVGL (const int iat, const int iStart, const int iEnd, const T distArray, T restrict valArray, T restrict gradArray, T restrict laplArray, T restrict distArrayCompressed, int restrict distIndices) const

real_type	f (real_type r) override
	evaluate the value at r More...

real_type	df (real_type r) override
	evaluate the first derivative More...

bool	evaluateDerivatives (real_type r, std::vector< TinyVector< real_type, 3 >> &derivs) override

bool	evaluateDerivatives (real_type r, std::vector< real_type > &derivs) override
	compute derivatives with respect to variational parameters More...

bool	put (xmlNodePtr cur) override
	process xmlnode and registers variables to optimize More...

void	checkInVariablesExclusive (opt_variables_type &active) override
	check in variational parameters to the global list of parameters used by the optimizer. More...

void	checkOutVariables (const opt_variables_type &active) override
	check out variational optimizable variables More...

void	resetParametersExclusive (const opt_variables_type &active) override
	reset the parameters during optimizations. More...

Public Member Functions inherited from OptimizableFunctorBase
	OptimizableFunctorBase (const std::string &name="")
	default constructor More...

virtual	~OptimizableFunctorBase ()=default
	virtual destrutor More...

void	getIndex (const opt_variables_type &active)

virtual void	setDensity (real_type n)
	empty virtual function to help builder classes More...

virtual void	setPeriodic (bool periodic)
	empty virtual function to help builder classes More...

virtual void	setGridManager (bool willmanage)

virtual void	checkInVariablesExclusive (opt_variables_type &active)=0
	check in variational parameters to the global list of parameters used by the optimizer. More...

virtual void	resetParametersExclusive (const opt_variables_type &active)=0
	reset the parameters during optimizations More...

Public Member Functions inherited from OptimizableObject
	OptimizableObject (const std::string &name)

const std::string &	getName () const

bool	isOptimized () const

virtual void	reportStatus (std::ostream &os)
	print the state, e.g., optimizables More...

void	setOptimization (bool state)

virtual void	writeVariationalParameters (hdf_archive &hout)
	Write the variational parameters for this object to the VP HDF file. More...

virtual void	readVariationalParameters (hdf_archive &hin)
	Read the variational parameters for this object from the VP HDF file. More...

Static Public Member Functions
static void	mw_evaluateV (const int num_groups, const UserFunctor const functors[], const int n_src, const int grp_ids, const int num_pairs, const int ref_at, const T mw_dist, const int dist_stride, T *mw_vals, Vector< char, OffloadPinnedAllocator< char >> &transfer_buffer)
	evaluate sum of the pair potentials FIXME More...

static void	mw_evaluateVGL (const int iat, const int num_groups, const UserFunctor const functors[], const int n_src, const int grp_ids, const int nw, T mw_vgl, const int n_padded, const T mw_dist, T *mw_cur_allu, Vector< char, OffloadPinnedAllocator< char >> &transfer_buffer)

static void	mw_updateVGL (const int iat, const std::vector< bool > &isAccepted, const int num_groups, const UserFunctor const functors[], const int n_src, const int grp_ids, const int nw, T mw_vgl, const int n_padded, const T mw_dist, T mw_allUat, T mw_cur_allu, Vector< char, OffloadPinnedAllocator< char >> &transfer_buffer)

Public Attributes
bool	Opt_A
	Is optimizable. More...

real_type	A
	Value. More...

std::string	ID_A
	Id in XML input. More...

bool	Opt_B
	Is optimizable. More...

real_type	B
	Value. More...

std::string	ID_B
	Id in XML input. More...

Public Attributes inherited from OptimizableFunctorBase
real_type	cutoff_radius = 0.0
	maximum cutoff More...

opt_variables_type	myVars
	set of variables to be optimized More...

Additional Inherited Members
Public Types inherited from OptimizableFunctorBase
using	real_type = optimize::VariableSet::real_type
	typedef for real values More...

using	opt_variables_type = optimize::VariableSet
	typedef for variableset: this is going to be replaced More...

Detailed Description

template<class T>
struct qmcplusplus::UserFunctor< T >

Implements the function f = A*r/(B*r + 1) - A/B.

Definition at line 47 of file UserFunctor.h.

Constructor & Destructor Documentation

◆ UserFunctor()

UserFunctor ( const std::string & my_name )

inline

default constructor

Definition at line 66 of file UserFunctor.h.

References UserFunctor< T >::reset().

Referenced by UserFunctor< T >::makeClone().

66 : OptimizableFunctorBase(my_name) { reset(); }

qmcplusplus::OptimizableFunctorBase::OptimizableFunctorBase

OptimizableFunctorBase(const std::string &name="")

default constructor

Definition: OptimizableFunctorBase.h:58

qmcplusplus::UserFunctor::reset

void reset() override

reset function

Definition: UserFunctor.h:80

Member Function Documentation

◆ checkInVariablesExclusive()

void checkInVariablesExclusive ( opt_variables_type & active )

inlineoverridevirtual

check in variational parameters to the global list of parameters used by the optimizer.

Parameters

active a super set of optimizable variables

The existing checkInVariables implementation in WFC/SPO/.. are inclusive and it calls checkInVariables of its members class A: public SPOSet {} class B: public WFC { A objA; checkInVariables() { objA.checkInVariables(); } };

With OptimizableObject, class A: public OptimizableObject {} class B: public OptimizableObject { A objA; checkInVariablesExclusive() { // should not call objA.checkInVariablesExclusive() if objA has been extracted; } }; A vector of OptimizableObject, will be created by calling extractOptimizableObjects(). All the checkInVariablesExclusive() will be called through this vector and thus checkInVariablesExclusive implementation should only handle non-OptimizableObject members.

Implements OptimizableObject.

Definition at line 307 of file UserFunctor.h.

References VariableSet::insertFrom(), and OptimizableFunctorBase::myVars.

Referenced by qmcplusplus::TEST_CASE().

   {
     active.insertFrom(myVars);
   }

◆ checkOutVariables()

void checkOutVariables ( const opt_variables_type & active )

inlineoverridevirtual

check out variational optimizable variables

Parameters

active a super set of optimizable variables

Implements OptimizableFunctorBase.

Definition at line 312 of file UserFunctor.h.

References VariableSet::getIndex(), and OptimizableFunctorBase::myVars.

   {
     myVars.getIndex(active);
   }

◆ df()

real_type df ( real_type r )

inlineoverridevirtual

evaluate the first derivative

Parameters

r distance

virtual function necessary for a transformation to a numerical functor

Implements OptimizableFunctorBase.

Definition at line 187 of file UserFunctor.h.

References UserFunctor< T >::evaluate().

   {
     real_type dudr, d2udr2;
     real_type res = evaluate(r, dudr, d2udr2);
     return dudr;
   }

◆ evaluate() [1/3]

real_type evaluate ( real_type r ) const

inline

Definition at line 85 of file UserFunctor.h.

References UserFunctor< T >::A, and UserFunctor< T >::B.

Referenced by UserFunctor< T >::df(), UserFunctor< T >::evaluateV(), UserFunctor< T >::evaluateVGL(), UserFunctor< T >::f(), and qmcplusplus::TEST_CASE().

85 { return A * r / (B * r + 1) - A / B; }

qmcplusplus::UserFunctor::A

real_type A

Value.

Definition: UserFunctor.h:52

qmcplusplus::UserFunctor::B

real_type B

Value.

Definition: UserFunctor.h:60

◆ evaluate() [2/3]

real_type evaluate	(	real_type	r,
		real_type &	dudr,
		real_type &	d2udr2
	)		const

inline

Definition at line 90 of file UserFunctor.h.

References UserFunctor< T >::A, and UserFunctor< T >::B.

   {
     dudr   = -A * B * r / ((B * r + 1) * (B * r + 1)) + A / (B * r + 1);
     d2udr2 = 2 * A * B * (B * r / (B * r + 1) - 1) / ((B * r + 1) * (B * r + 1));
     return A * r / (B * r + 1) - A / B;
   }

◆ evaluate() [3/3]

real_type evaluate	(	real_type	r,
		real_type &	dudr,
		real_type &	d2udr2,
		real_type &	d3udr3
	)		const

inline

Definition at line 100 of file UserFunctor.h.

References UserFunctor< T >::A, UserFunctor< T >::B, and qmcplusplus::pow().

   {
     dudr   = -A * B * r / ((B * r + 1) * (B * r + 1)) + A / (B * r + 1);
     d2udr2 = 2 * A * B * (B * r / (B * r + 1) - 1) / ((B * r + 1) * (B * r + 1));
     d3udr3 = 6 * A * ((B) * (B)) * (-B * r / (B * r + 1) + 1) / std::pow(B * r + 1, 3);
     return A * r / (B * r + 1) - A / B;
   }

◆ evaluateDerivatives() [1/2]

bool evaluateDerivatives	(	real_type	r,
		std::vector< TinyVector< real_type, 3 >> &	derivs
	)

inlineoverridevirtual

Reimplemented from OptimizableFunctorBase.

Definition at line 213 of file UserFunctor.h.

References UserFunctor< T >::A, UserFunctor< T >::B, UserFunctor< T >::Opt_A, UserFunctor< T >::Opt_B, and qmcplusplus::pow().

Referenced by qmcplusplus::TEST_CASE().

   {
     int i = 0;
 
     if (Opt_A)
     {
       derivs[i][0] = r / (B * r + 1) - 1 / B;
       derivs[i][1] = -B * r / ((B * r + 1) * (B * r + 1)) + 1.0 / (B * r + 1);
       derivs[i][2] = 2 * B * (B * r / (B * r + 1) - 1) / ((B * r + 1) * (B * r + 1));
       ++i;
     }
 
     if (Opt_B)
     {
       derivs[i][0] = -A * ((r) * (r)) / ((B * r + 1) * (B * r + 1)) + A / ((B) * (B));
       derivs[i][1] = 2 * A * B * ((r) * (r)) / std::pow(B * r + 1, 3) - 2 * A * r / ((B * r + 1) * (B * r + 1));
       derivs[i][2] = -4 * A * B * r * (B * r / (B * r + 1) - 1) / std::pow(B * r + 1, 3) +
           2 * A * B * (-B * ((r) * (r)) / ((B * r + 1) * (B * r + 1)) + r / (B * r + 1)) / ((B * r + 1) * (B * r + 1)) +
           2 * A * (B * r / (B * r + 1) - 1) / ((B * r + 1) * (B * r + 1));
       ++i;
     }
 
     return true;
   }

◆ evaluateDerivatives() [2/2]

bool evaluateDerivatives	(	real_type	r,
		std::vector< real_type > &	derivs
	)

inlineoverridevirtual

compute derivatives with respect to variational parameters

Reimplemented from OptimizableFunctorBase.

Definition at line 240 of file UserFunctor.h.

References UserFunctor< T >::A, UserFunctor< T >::B, UserFunctor< T >::Opt_A, and UserFunctor< T >::Opt_B.

   {
     int i = 0;
 
     if (Opt_A)
     {
       derivs[i] = r / (B * r + 1) - 1 / B;
       ++i;
     }
 
     if (Opt_B)
     {
       derivs[i] = -A * ((r) * (r)) / ((B * r + 1) * (B * r + 1)) + A / ((B) * (B));
       ++i;
     }
 
 
     return true;
   }

◆ evaluateV()

real_type evaluateV	(	const int	iat,
		const int	iStart,
		const int	iEnd,
		const T *restrict	_distArray,
		T *restrict	distArrayCompressed
	)		const

inline

Definition at line 109 of file UserFunctor.h.

References UserFunctor< T >::evaluate().

   {
     // specialized evaluation loop?
     real_type sum(0);
     for (int idx = iStart; idx < iEnd; idx++)
       if (idx != iat)
         sum += evaluate(_distArray[idx]);
     return sum;
   }

◆ evaluateVGL()

void evaluateVGL	(	const int	iat,
		const int	iStart,
		const int	iEnd,
		const T *	distArray,
		T *restrict	valArray,
		T *restrict	gradArray,
		T *restrict	laplArray,
		T *restrict	distArrayCompressed,
		int *restrict	distIndices
	)		const

inline

Definition at line 150 of file UserFunctor.h.

References UserFunctor< T >::evaluate().

   {
     // specialized evaluation loop?
     for (int idx = iStart; idx < iEnd; idx++)
     {
       valArray[idx] = evaluate(distArray[idx], gradArray[idx], laplArray[idx]);
       gradArray[idx] /= distArray[idx];
     }
     if (iat >= iStart && iat < iEnd)
       valArray[iat] = gradArray[iat] = laplArray[iat] = T(0);
   }

◆ f()

real_type f ( real_type r )

inlineoverridevirtual

evaluate the value at r

Parameters

r distance

virtual function necessary for a transformation to a numerical functor

Implements OptimizableFunctorBase.

Definition at line 185 of file UserFunctor.h.

References UserFunctor< T >::evaluate().

185 { return evaluate(r); }

qmcplusplus::UserFunctor::evaluate

real_type evaluate(real_type r) const

Definition: UserFunctor.h:85

◆ makeClone()

OptimizableFunctorBase* makeClone ( ) const

inlineoverridevirtual

create a clone of this object

Implements OptimizableFunctorBase.

Definition at line 78 of file UserFunctor.h.

References UserFunctor< T >::UserFunctor().

78 { return new UserFunctor(*this); }

qmcplusplus::UserFunctor::UserFunctor

UserFunctor(const std::string &my_name)

default constructor

Definition: UserFunctor.h:66

◆ mw_evaluateV()

static void mw_evaluateV	(	const int	num_groups,
		const UserFunctor< T > *const	functors[],
		const int	n_src,
		const int *	grp_ids,
		const int	num_pairs,
		const int *	ref_at,
		const T *	mw_dist,
		const int	dist_stride,
		T *	mw_vals,
		Vector< char, OffloadPinnedAllocator< char >> &	transfer_buffer
	)

inlinestatic

evaluate sum of the pair potentials FIXME

Returns: $\sum u(r_j)$ for r_j < cutoff_radius

Definition at line 126 of file UserFunctor.h.

   {
     for (int ip = 0; ip < num_pairs; ip++)
     {
       mw_vals[ip] = 0;
       for (int j = 0; j < n_src; j++)
       {
         const int ig = grp_ids[j];
         auto& functor(*functors[ig]);
         if (j != ref_at[ip])
           mw_vals[ip] += functor.evaluate(mw_dist[ip * dist_stride + j]);
       }
     }
   }

◆ mw_evaluateVGL()

static void mw_evaluateVGL	(	const int	iat,
		const int	num_groups,
		const UserFunctor< T > *const	functors[],
		const int	n_src,
		const int *	grp_ids,
		const int	nw,
		T *	mw_vgl,
		const int	n_padded,
		const T *	mw_dist,
		T *	mw_cur_allu,
		Vector< char, OffloadPinnedAllocator< char >> &	transfer_buffer
	)

inlinestatic

Definition at line 170 of file UserFunctor.h.

   {
     throw std::runtime_error("UserFunctor mw_evaluateVGL not implemented!");
   }

◆ mw_updateVGL()

static void mw_updateVGL	(	const int	iat,
		const std::vector< bool > &	isAccepted,
		const int	num_groups,
		const UserFunctor< T > *const	functors[],
		const int	n_src,
		const int *	grp_ids,
		const int	nw,
		T *	mw_vgl,
		const int	n_padded,
		const T *	mw_dist,
		T *	mw_allUat,
		T *	mw_cur_allu,
		Vector< char, OffloadPinnedAllocator< char >> &	transfer_buffer
	)

inlinestatic

Definition at line 194 of file UserFunctor.h.

   {
     throw std::runtime_error("UserFunctor mw_updateVGL not implemented!");
   }

◆ put()

bool put ( xmlNodePtr cur )

inlineoverridevirtual

process xmlnode and registers variables to optimize

Parameters

cur	xmlNode for a functor

Implements OptimizableFunctorBase.

Definition at line 263 of file UserFunctor.h.

References UserFunctor< T >::A, OhmmsAttributeSet::add(), UserFunctor< T >::B, VariableSet::clear(), UserFunctor< T >::ID_A, UserFunctor< T >::ID_B, VariableSet::insert(), OptimizableFunctorBase::myVars, UserFunctor< T >::Opt_A, UserFunctor< T >::Opt_B, optimize::OTHER_P, OhmmsAttributeSet::put(), putContent(), and UserFunctor< T >::reset().

Referenced by qmcplusplus::TEST_CASE().

   {
     cur = cur->xmlChildrenNode;
     while (cur != NULL)
     {
       std::string cname((const char*)(cur->name));
       if (cname == "var") //only accept var
       {
         std::string id_in;
         std::string p_name;
         OhmmsAttributeSet rAttrib;
         rAttrib.add(id_in, "id");
         rAttrib.add(p_name, "name");
         rAttrib.put(cur);
 
         if (p_name == "A")
         {
           ID_A = id_in;
           putContent(A, cur);
           Opt_A = true;
         }
 
         if (p_name == "B")
         {
           ID_B = id_in;
           putContent(B, cur);
           Opt_B = true;
         }
       }
       cur = cur->next;
     }
     reset();
     myVars.clear();
 
     if (Opt_A)
       myVars.insert(ID_A, A, Opt_A, optimize::OTHER_P);
 
     if (Opt_B)
       myVars.insert(ID_B, B, Opt_B, optimize::OTHER_P);
 
     return true;
   }

◆ reset()

void reset ( )

inlineoverridevirtual

reset function

Implements OptimizableFunctorBase.

Definition at line 80 of file UserFunctor.h.

Referenced by UserFunctor< T >::put(), UserFunctor< T >::resetParametersExclusive(), UserFunctor< T >::setCusp(), and UserFunctor< T >::UserFunctor().

80 {}

◆ resetParametersExclusive()

void resetParametersExclusive ( const opt_variables_type & active )

inlineoverridevirtual

reset the parameters during optimizations.

Exclusive, see checkInVariablesExclusive

Implements OptimizableObject.

Definition at line 317 of file UserFunctor.h.

References UserFunctor< T >::A, UserFunctor< T >::B, OptimizableFunctorBase::myVars, UserFunctor< T >::Opt_A, UserFunctor< T >::Opt_B, UserFunctor< T >::reset(), VariableSet::size(), and VariableSet::where().

Referenced by qmcplusplus::TEST_CASE().

   {
     if (myVars.size())
     {
       int ia = myVars.where(0);
       if (ia > -1)
       {
         int i = 0;
 
         if (Opt_A)
           A = std::real(myVars[i++] = active[ia++]);
 
         if (Opt_B)
           B = std::real(myVars[i++] = active[ia++]);
       }
       reset();
     }
   }

◆ setCusp()

void setCusp ( real_type cusp )

inlineoverridevirtual

empty virtual function to help builder classes

Reimplemented from OptimizableFunctorBase.

Definition at line 70 of file UserFunctor.h.

References UserFunctor< T >::A, UserFunctor< T >::Opt_A, and UserFunctor< T >::reset().

Referenced by qmcplusplus::TEST_CASE().

   {
     A     = cusp;
     Opt_A = false;
     reset();
   }

Member Data Documentation

◆ A

real_type A

Value.

Definition at line 52 of file UserFunctor.h.

Referenced by UserFunctor< T >::evaluate(), UserFunctor< T >::evaluateDerivatives(), UserFunctor< T >::put(), UserFunctor< T >::resetParametersExclusive(), UserFunctor< T >::setCusp(), and qmcplusplus::TEST_CASE().

◆ B

real_type B

Value.

Definition at line 60 of file UserFunctor.h.

Referenced by UserFunctor< T >::evaluate(), UserFunctor< T >::evaluateDerivatives(), UserFunctor< T >::put(), UserFunctor< T >::resetParametersExclusive(), and qmcplusplus::TEST_CASE().

◆ ID_A

std::string ID_A

Id in XML input.

Definition at line 54 of file UserFunctor.h.

Referenced by UserFunctor< T >::put().

◆ ID_B

std::string ID_B

Id in XML input.

Definition at line 62 of file UserFunctor.h.

Referenced by UserFunctor< T >::put().

◆ Opt_A

bool Opt_A

Is optimizable.

Definition at line 50 of file UserFunctor.h.

Referenced by UserFunctor< T >::evaluateDerivatives(), UserFunctor< T >::put(), UserFunctor< T >::resetParametersExclusive(), and UserFunctor< T >::setCusp().

◆ Opt_B

bool Opt_B

Is optimizable.

Definition at line 58 of file UserFunctor.h.

Referenced by UserFunctor< T >::evaluateDerivatives(), UserFunctor< T >::put(), and UserFunctor< T >::resetParametersExclusive().

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

/home/pk7/projects/qmc/for_cron_doxygen/qmcpack/src/QMCWaveFunctions/Jastrow/UserFunctor.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

template<class T> struct qmcplusplus::UserFunctor< T >

Constructor & Destructor Documentation

◆ UserFunctor()

Member Function Documentation

◆ checkInVariablesExclusive()

◆ checkOutVariables()

◆ df()

◆ evaluate() [1/3]

◆ evaluate() [2/3]

◆ evaluate() [3/3]

◆ evaluateDerivatives() [1/2]

◆ evaluateDerivatives() [2/2]

◆ evaluateV()

◆ evaluateVGL()

◆ f()

◆ makeClone()

◆ mw_evaluateV()

◆ mw_evaluateVGL()

◆ mw_updateVGL()

◆ put()

◆ reset()

◆ resetParametersExclusive()

◆ setCusp()

Member Data Documentation

◆ A

◆ B

◆ ID_A

◆ ID_B

◆ Opt_A

◆ Opt_B

template<class T>
struct qmcplusplus::UserFunctor< T >