pairPotential Class Referenceabstract
Inheritance diagram for pairPotential:
Collaboration diagram for pairPotential:

Public Member Functions

 TypeName ("pairPotential")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, pairPotential, dictionary,(const word &name, const dictionary &pairPotentialProperties),(name, pairPotentialProperties))
 
 pairPotential (const word &name, const dictionary &pairPotentialProperties)
 Construct from components. More...
 
 pairPotential (const pairPotential &)
 Disallow default bitwise copy construction. More...
 
virtual ~pairPotential ()
 Destructor. More...
 
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
 
virtual scalar unscaledEnergy (const scalar r) const =0
 
scalar scaledEnergy (const scalar r) const
 
scalar energyDerivative (const scalar r, const bool scaledEnergyDerivative=true) const
 
const dictionarypairPotentialProperties () const
 
bool writeEnergyAndForceTables (Ostream &os) const
 
virtual bool read (const dictionary &pairPotentialProperties)=0
 Read pairPotential dictionary. More...
 
void operator= (const pairPotential &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< pairPotentialNew (const word &name, const dictionary &pairPotentialProperties)
 Return a reference to the selected viscosity model. More...
 

Protected Member Functions

void scaleEnergy (scalar &e, const scalar r) const
 

Protected Attributes

word name_
 
dictionary pairPotentialProperties_
 
scalar rCut_
 
scalar rCutSqr_
 
scalar rMin_
 
scalar dr_
 
List< scalar > forceLookup_
 
List< scalar > energyLookup_
 
energyScalingFunctionesfPtr_
 
bool writeTables_
 

Detailed Description

Source files

Definition at line 57 of file pairPotential.H.

Constructor & Destructor Documentation

◆ pairPotential() [1/2]

pairPotential ( const word name,
const dictionary pairPotentialProperties 
)

Construct from components.

Definition at line 56 of file pairPotential.C.

◆ pairPotential() [2/2]

Disallow default bitwise copy construction.

◆ ~pairPotential()

virtual ~pairPotential ( )
inlinevirtual

Destructor.

Definition at line 131 of file pairPotential.H.

Member Function Documentation

◆ scaleEnergy()

void scaleEnergy ( scalar &  e,
const scalar  r 
) const
protected

◆ TypeName()

TypeName ( "pairPotential"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
pairPotential  ,
dictionary  ,
(const word &name, const dictionary &pairPotentialProperties ,
(name, pairPotentialProperties  
)

◆ New()

Foam::autoPtr< Foam::pairPotential > New ( const word name,
const dictionary pairPotentialProperties 
)
static

Return a reference to the selected viscosity model.

Definition at line 31 of file pairPotentialNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ setLookupTables()

void setLookupTables ( )

◆ rMin()

Foam::scalar rMin ( ) const
inline

Definition at line 28 of file pairPotentialI.H.

References pairPotential::rMin_.

◆ dr()

Foam::scalar dr ( ) const
inline

Definition at line 34 of file pairPotentialI.H.

◆ rCut()

Foam::scalar rCut ( ) const
inline

Definition at line 40 of file pairPotentialI.H.

◆ rCutSqr()

Foam::scalar rCutSqr ( ) const
inline

Definition at line 46 of file pairPotentialI.H.

◆ energy()

Foam::scalar energy ( const scalar  r) const

Definition at line 131 of file pairPotential.C.

References Foam::abort(), Foam::e, Foam::FatalError, FatalErrorInFunction, k, and Foam::nl.

Here is the call graph for this function:

◆ force()

Foam::scalar force ( const scalar  r) const

Definition at line 94 of file pairPotential.C.

References Foam::abort(), f(), Foam::FatalError, FatalErrorInFunction, k, and Foam::nl.

Here is the call graph for this function:

◆ energyTable()

Foam::List< Foam::Pair< Foam::scalar > > energyTable ( ) const

Definition at line 153 of file pairPotential.C.

References UList< T >::first(), forAll, and k.

Referenced by pairPotential::writeEnergyAndForceTables().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ forceTable()

Foam::List< Foam::Pair< Foam::scalar > > forceTable ( ) const

Definition at line 116 of file pairPotential.C.

References UList< T >::first(), forAll, and k.

Referenced by pairPotential::writeEnergyAndForceTables().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeTables()

bool writeTables ( ) const
inline

Definition at line 52 of file pairPotentialI.H.

◆ unscaledEnergy()

virtual scalar unscaledEnergy ( const scalar  r) const
pure virtual

◆ scaledEnergy()

Foam::scalar scaledEnergy ( const scalar  r) const

Definition at line 168 of file pairPotential.C.

References Foam::e.

◆ energyDerivative()

Foam::scalar energyDerivative ( const scalar  r,
const bool  scaledEnergyDerivative = true 
) const

Definition at line 178 of file pairPotential.C.

References Ea().

Here is the call graph for this function:

◆ pairPotentialProperties()

const dictionary& pairPotentialProperties ( ) const
inline

Definition at line 167 of file pairPotential.H.

References pairPotential::pairPotentialProperties_.

Referenced by coulomb::read(), dampedCoulomb::read(), lennardJones::read(), and noInteraction::read().

Here is the caller graph for this function:

◆ writeEnergyAndForceTables()

bool writeEnergyAndForceTables ( Ostream os) const

◆ read()

bool read ( const dictionary pairPotentialProperties)
pure virtual

◆ operator=()

void operator= ( const pairPotential )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ name_

word name_
protected

◆ pairPotentialProperties_

dictionary pairPotentialProperties_
protected

◆ rCut_

scalar rCut_
protected

Definition at line 67 of file pairPotential.H.

◆ rCutSqr_

scalar rCutSqr_
protected

Definition at line 68 of file pairPotential.H.

◆ rMin_

scalar rMin_
protected

Definition at line 70 of file pairPotential.H.

Referenced by pairPotential::rMin().

◆ dr_

scalar dr_
protected

Definition at line 71 of file pairPotential.H.

◆ forceLookup_

List<scalar> forceLookup_
protected

Definition at line 73 of file pairPotential.H.

◆ energyLookup_

List<scalar> energyLookup_
protected

Definition at line 74 of file pairPotential.H.

◆ esfPtr_

energyScalingFunction* esfPtr_
mutableprotected

Definition at line 76 of file pairPotential.H.

Referenced by pairPotential::scaleEnergy().

◆ writeTables_

bool writeTables_
protected

Definition at line 78 of file pairPotential.H.


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