coulomb Class Reference

#include <coulomb.H>

Inheritance diagram for coulomb:

Collaboration diagram for coulomb:

Public Member Functions
	TypeName ("coulomb")
	Runtime type information.
	coulomb (const word &name, const dictionary &pairPotentialProperties)
	Construct from components.
	~coulomb ()
	Destructor.
scalar	unscaledEnergy (const scalar r) const
bool	read (const dictionary &pairPotentialProperties)
	Read dictionary.
Public Member Functions inherited from pairPotential
	TypeName ("pairPotential")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, pairPotential, dictionary,(const word &name, const dictionary &pairPotentialProperties),(name, pairPotentialProperties))
	pairPotential (const word &name, const dictionary &pairPotentialProperties)
	Construct from components.
virtual	~pairPotential ()=default
	Destructor.
void	setLookupTables ()
scalar	rMin () const
scalar	dr () const
scalar	rCut () const
scalar	rCutSqr () const
scalar	energy (const scalar r) const
scalar	force (const scalar r) const
List< Pair< scalar > >	energyTable () const
List< Pair< scalar > >	forceTable () const
bool	writeTables () const
scalar	scaledEnergy (const scalar r) const
scalar	energyDerivative (const scalar r, const bool scaledEnergyDerivative=true) const
const dictionary &	pairPotentialProperties () const
bool	writeEnergyAndForceTables (Ostream &os) const

Static Public Attributes
static scalar	oneOverFourPiEps0

Additional Inherited Members
Static Public Member Functions inherited from pairPotential
static autoPtr< pairPotential >	New (const word &name, const dictionary &pairPotentialProperties)
	Return a reference to the selected viscosity model.
Protected Member Functions inherited from pairPotential
void	scaleEnergy (scalar &e, const scalar r) const
	pairPotential (const pairPotential &)=delete
	No copy construct.
void	operator= (const pairPotential &)=delete
	No copy assignment.
Protected Attributes inherited from pairPotential
word	name_
dictionary	pairPotentialProperties_
scalar	rCut_
scalar	rCutSqr_
scalar	rMin_
scalar	dr_
List< scalar >	forceLookup_
List< scalar >	energyLookup_
energyScalingFunction *	esfPtr_
bool	writeTables_

Detailed Description

Source files

• coulomb.H
• coulomb.C

Definition at line 48 of file coulomb.H.

Constructor & Destructor Documentation

coulomb()

coulomb	(	const word &	name,
		const dictionary &	pairPotentialProperties )

Construct from components.

Definition at line 49 of file coulomb.C.

References Foam::name(), pairPotential::pairPotential(), pairPotential::pairPotentialProperties(), and pairPotential::setLookupTables().

Here is the call graph for this function:

~coulomb()

~coulomb ( )

inline

Destructor.

Definition at line 79 of file coulomb.H.

Member Function Documentation

TypeName()

TypeName

(

"coulomb"

)

Runtime type information.

unscaledEnergy()

scalar unscaledEnergy ( const scalar r ) const

virtual

Implements pairPotential.

Definition at line 63 of file coulomb.C.

References oneOverFourPiEps0.

read()

bool read ( const dictionary & pairPotentialProperties )

virtual

Read dictionary.

Implements pairPotential.

Definition at line 69 of file coulomb.C.

References pairPotential::pairPotentialProperties(), and pairPotential::read().

Here is the call graph for this function:

Member Data Documentation

oneOverFourPiEps0

scalar oneOverFourPiEps0

static

Initial value:

                              =
1.0/(4.0*constant::mathematical::pi*8.854187817e-12)

Definition at line 62 of file coulomb.H.

Referenced by Foam::pairPotentials::addToRunTimeSelectionTable(), and unscaledEnergy().

---

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

• src/lagrangian/molecularDynamics/potential/pairPotential/derived/coulomb/coulomb.H
• src/lagrangian/molecularDynamics/potential/pairPotential/derived/coulomb/coulomb.C