#include <FakeFrame.h>

Inheritance diagram for PLMD::FakeFrame:

Public Member Functions
	FakeFrame (const ReferenceConfigurationOptions &ro)

double	calc (const std::vector< Vector > &pos, const Pbc &pbc, const std::vector< Value *> &vals, const std::vector< double > &arg, ReferenceValuePack &myder, const bool &squared) const
	Calculate the distance from the reference configuration. More...

double	calculate (const std::vector< Vector > &pos, const Pbc &pbc, const std::vector< Value *> &vals, ReferenceValuePack &myder, const bool &squared=false) const
	Calculate the distance from the reference configuration. More...

void	copyDerivatives (const ReferenceConfiguration *)
	Parse something from the pdb remarks Copy derivatives from one frame to this frame. More...

void	displaceReferenceConfiguration (const double &weight, Direction &dir)
	Move the reference configuration by an ammount specified using a Direction. More...

void	extractDisplacementVector (const std::vector< Vector > &pos, const std::vector< Value *> &vals, const std::vector< double > &arg, const bool &nflag, Direction &mydir) const
	Extract a Direction giving you the displacement from some position. More...

virtual const std::vector< AtomNumber > &	getAbsoluteIndexes ()
	These are overwritten in ReferenceArguments and ReferenceAtoms to make frame copying work. More...

virtual const std::vector< std::string > &	getArgumentNames ()

virtual void	getArgumentRequests (std::vector< std::string > &, bool disable_checks=false)
	Retrieve the arguments that are required for this guy. More...

virtual void	getAtomRequests (std::vector< AtomNumber > &, bool disable_checks=false)
	Retrieve the atoms that are required for this guy. More...

std::string	getName () const
	Return the name of this metric. More...

virtual unsigned	getNumberOfReferenceArguments () const

virtual unsigned	getNumberOfReferencePositions () const

virtual double	getReferenceArgument (const unsigned &i) const
	Get one of the referene arguments. More...

virtual const std::vector< double > &	getReferenceArguments () const

virtual const std::vector< double > &	getReferenceMetric ()

virtual const std::vector< Vector > &	getReferencePositions () const
	These are overwritten in ReferenceArguments and ReferenceAtoms but are required here to make PLMD::distance work. More...

virtual bool	pcaIsEnabledForThisReference ()
	Stuff for pca. More...

double	projectDisplacementOnVector (const Direction &mydir, const std::vector< Value *> &vals, const std::vector< double > &arg, ReferenceValuePack &mypack) const

void	read (const PDB &)
	Do all local business for setting the configuration. More...

virtual void	setupPCAStorage (ReferenceValuePack &mypack)
	Stuff to setup pca. More...

Protected Member Functions
void	error (const std::string &msg)
	Crash with an error. More...

Constructor & Destructor Documentation

◆ FakeFrame()

PLMD::FakeFrame::FakeFrame ( const ReferenceConfigurationOptions & ro )

inlineexplicit

Member Function Documentation

◆ calc()

double PLMD::FakeFrame::calc	(	const std::vector< Vector > &	pos,
		const Pbc &	pbc,
		const std::vector< Value *> &	vals,
		const std::vector< double > &	args,
		ReferenceValuePack &	myder,
		const bool &	squared
	)		const

inlinevirtual

Calculate the distance from the reference configuration.

Implements PLMD::ReferenceConfiguration.

◆ calculate()

double PLMD::ReferenceConfiguration::calculate	(	const std::vector< Vector > &	pos,
		const Pbc &	pbc,
		const std::vector< Value *> &	vals,
		ReferenceValuePack &	myder,
		const bool &	squared = `false`
	)		const

inherited

Calculate the distance from the reference configuration.

◆ copyDerivatives()

void PLMD::ReferenceConfiguration::copyDerivatives ( const ReferenceConfiguration * )

inherited

Parse something from the pdb remarks Copy derivatives from one frame to this frame.

◆ displaceReferenceConfiguration()

void PLMD::ReferenceConfiguration::displaceReferenceConfiguration	(	const double &	weight,
		Direction &	dir
	)

inherited

Move the reference configuration by an ammount specified using a Direction.

◆ error()

void PLMD::ReferenceConfiguration::error ( const std::string & msg )

protectedinherited

Crash with an error.

◆ extractDisplacementVector()

void PLMD::ReferenceConfiguration::extractDisplacementVector	(	const std::vector< Vector > &	pos,
		const std::vector< Value *> &	vals,
		const std::vector< double > &	arg,
		const bool &	nflag,
		Direction &	mydir
	)		const

inherited

Extract a Direction giving you the displacement from some position.

◆ getAbsoluteIndexes()

const std::vector< AtomNumber > & PLMD::ReferenceConfiguration::getAbsoluteIndexes ( )

inlinevirtualinherited

These are overwritten in ReferenceArguments and ReferenceAtoms to make frame copying work.

Reimplemented in PLMD::ReferenceAtoms.

◆ getArgumentNames()

const std::vector< std::string > & PLMD::ReferenceConfiguration::getArgumentNames ( )

inlinevirtualinherited

Reimplemented in PLMD::ReferenceArguments.

◆ getArgumentRequests()

virtual void PLMD::ReferenceConfiguration::getArgumentRequests	(	std::vector< std::string > &	,
		bool	disable_checks = `false`
	)

inlinevirtualinherited

Retrieve the arguments that are required for this guy.

Reimplemented in PLMD::ReferenceArguments.

◆ getAtomRequests()

virtual void PLMD::ReferenceConfiguration::getAtomRequests	(	std::vector< AtomNumber > &	,
		bool	disable_checks = `false`
	)

inlinevirtualinherited

Retrieve the atoms that are required for this guy.

Reimplemented in PLMD::ReferenceAtoms.

◆ getName()

std::string PLMD::ReferenceConfiguration::getName ( ) const

inherited

Return the name of this metric.

◆ getNumberOfReferenceArguments()

unsigned PLMD::ReferenceConfiguration::getNumberOfReferenceArguments ( ) const

inlinevirtualinherited

Reimplemented in PLMD::ReferenceArguments.

◆ getNumberOfReferencePositions()

unsigned PLMD::ReferenceConfiguration::getNumberOfReferencePositions ( ) const

inlinevirtualinherited

Reimplemented in PLMD::ReferenceAtoms.

◆ getReferenceArgument()

virtual double PLMD::ReferenceConfiguration::getReferenceArgument ( const unsigned & i ) const

inlinevirtualinherited

Get one of the referene arguments.

Reimplemented in PLMD::ReferenceArguments.

◆ getReferenceArguments()

const std::vector< double > & PLMD::ReferenceConfiguration::getReferenceArguments ( ) const

inlinevirtualinherited

Reimplemented in PLMD::ReferenceArguments.

◆ getReferenceMetric()

const std::vector< double > & PLMD::ReferenceConfiguration::getReferenceMetric ( )

inlinevirtualinherited

Reimplemented in PLMD::ReferenceArguments.

◆ getReferencePositions()

const std::vector< Vector > & PLMD::ReferenceConfiguration::getReferencePositions ( ) const

inlinevirtualinherited

These are overwritten in ReferenceArguments and ReferenceAtoms but are required here to make PLMD::distance work.

Reimplemented in PLMD::ReferenceAtoms.

◆ pcaIsEnabledForThisReference()

virtual bool PLMD::ReferenceConfiguration::pcaIsEnabledForThisReference ( )

inlinevirtualinherited

Stuff for pca.

Reimplemented in PLMD::MultiDomainRMSD, PLMD::ArgumentOnlyDistance, PLMD::OptimalRMSD, and PLMD::SimpleRMSD.

◆ projectDisplacementOnVector()

double PLMD::ReferenceConfiguration::projectDisplacementOnVector	(	const Direction &	mydir,
		const std::vector< Value *> &	vals,
		const std::vector< double > &	arg,
		ReferenceValuePack &	mypack
	)		const

inherited

◆ read()

void PLMD::FakeFrame::read ( const PDB & )

inlinevirtual

Do all local business for setting the configuration.

Implements PLMD::ReferenceConfiguration.

◆ setupPCAStorage()

virtual void PLMD::ReferenceConfiguration::setupPCAStorage ( ReferenceValuePack & mypack )

inlinevirtualinherited

Stuff to setup pca.

Reimplemented in PLMD::MultiDomainRMSD, PLMD::ArgumentOnlyDistance, PLMD::OptimalRMSD, and PLMD::SimpleRMSD.

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

reference/FakeFrame.h

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

◆ FakeFrame()

Member Function Documentation

◆ calc()

◆ calculate()

◆ copyDerivatives()

◆ displaceReferenceConfiguration()

◆ error()

◆ extractDisplacementVector()

◆ getAbsoluteIndexes()

◆ getArgumentNames()

◆ getArgumentRequests()

◆ getAtomRequests()

◆ getName()

◆ getNumberOfReferenceArguments()

◆ getNumberOfReferencePositions()

◆ getReferenceArgument()

◆ getReferenceArguments()

◆ getReferenceMetric()

◆ getReferencePositions()

◆ pcaIsEnabledForThisReference()

◆ projectDisplacementOnVector()

◆ read()

◆ setupPCAStorage()