pairPotentialList Class Reference
Inheritance diagram for pairPotentialList:
[legend]
Collaboration diagram for pairPotentialList:
[legend]

Public Member Functions

 pairPotentialList ()
 
 pairPotentialList (const List< word > &idList, const dictionary &pairPotentialDict, const polyMesh &mesh)
 Construct from idList and potential dictionaries. More...
 
 ~pairPotentialList ()
 Destructor. More...
 
void buildPotentials (const List< word > &idList, const dictionary &pairPotentialDict, const polyMesh &mesh)
 
scalar rCutMax () const
 
scalar rCutMaxSqr () const
 
bool rCutMaxSqr (scalar rIJMagSqr) const
 
const pairPotentialpairPotentialFunction (const label a, const label b) const
 
bool rCutSqr (const label a, const label b, const scalar rIJMagSqr) const
 
scalar rMin (const label a, const label b) const
 
scalar dr (const label a, const label b) const
 
scalar rCutSqr (const label a, const label b) const
 
scalar rCut (const label a, const label b) const
 
scalar force (const label a, const label b, const scalar rIJMag) const
 
scalar energy (const label a, const label b, const scalar rIJMag) const
 
const pairPotentialelectrostatic () const
 
- Public Member Functions inherited from PtrList< pairPotential >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< pairPotential > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< pairPotential > &&list)
 Move construct. More...
 
 PtrList (UList< pairPotential * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< pairPotential > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< pairPotential > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< pairPotential > &list)
 Copy construct using 'clone()' on each element of SLPtrList<T> More...
 
 PtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
PtrList< pairPotentialclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< pairPotentialclone (Args &&... args) const
 
const pairPotentialset (const label i) const
 Return const pointer to element (can be nullptr),. More...
 
autoPtr< pairPotentialset (const label i, pairPotential *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< pairPotentialset (const label i, autoPtr< pairPotential > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< pairPotentialset (const label i, autoPtr< pairPotential > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< pairPotentialset (const label i, std::unique_ptr< pairPotential > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< pairPotentialset (const label i, const refPtr< pairPotential > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< pairPotentialset (const label i, const tmp< pairPotential > &ptr)
 Set element to given tmp and return old element. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void emplace_append (Args &&... args)
 Construct and append an element to the end of the list. More...
 
void append (pairPotential *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< pairPotential > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< pairPotential > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< pairPotential > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< pairPotential > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< pairPotential > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
autoPtr< pairPotentialemplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< pairPotentialemplace (const label i, Args &&... args)
 
autoPtr< pairPotentialrelease (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< pairPotential > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< pairPotential > &list)
 Copy assignment. More...
 
void operator= (PtrList< pairPotential > &&list)
 Move assignment. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PtrList< pairPotential >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
void free ()
 Delete the allocated entries, but retain the list size. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ pairPotentialList() [1/2]

Definition at line 192 of file pairPotentialList.C.

◆ pairPotentialList() [2/2]

pairPotentialList ( const List< word > &  idList,
const dictionary pairPotentialDict,
const polyMesh mesh 
)

Construct from idList and potential dictionaries.

Definition at line 199 of file pairPotentialList.C.

References mesh.

◆ ~pairPotentialList()

Destructor.

Definition at line 213 of file pairPotentialList.C.

Member Function Documentation

◆ buildPotentials()

void buildPotentials ( const List< word > &  idList,
const dictionary pairPotentialDict,
const polyMesh mesh 
)

Definition at line 220 of file pairPotentialList.C.

References mesh, and setSize().

Here is the call graph for this function:

◆ rCutMax()

Foam::scalar rCutMax ( ) const
inline

Definition at line 62 of file pairPotentialListI.H.

◆ rCutMaxSqr() [1/2]

Foam::scalar rCutMaxSqr ( ) const
inline

Definition at line 68 of file pairPotentialListI.H.

◆ rCutMaxSqr() [2/2]

bool rCutMaxSqr ( scalar  rIJMagSqr) const

Definition at line 244 of file pairPotentialList.C.

◆ pairPotentialFunction()

const Foam::pairPotential & pairPotentialFunction ( const label  a,
const label  b 
) const

Definition at line 235 of file pairPotentialList.C.

References Foam::constant::physicoChemical::b.

◆ rCutSqr() [1/2]

bool rCutSqr ( const label  a,
const label  b,
const scalar  rIJMagSqr 
) const

Definition at line 256 of file pairPotentialList.C.

References Foam::constant::physicoChemical::b.

◆ rMin()

Foam::scalar rMin ( const label  a,
const label  b 
) const

Definition at line 272 of file pairPotentialList.C.

References Foam::constant::physicoChemical::b.

◆ dr()

Foam::scalar dr ( const label  a,
const label  b 
) const

Definition at line 282 of file pairPotentialList.C.

References Foam::constant::physicoChemical::b.

◆ rCutSqr() [2/2]

Foam::scalar rCutSqr ( const label  a,
const label  b 
) const

Definition at line 292 of file pairPotentialList.C.

References Foam::constant::physicoChemical::b.

◆ rCut()

Foam::scalar rCut ( const label  a,
const label  b 
) const

Definition at line 302 of file pairPotentialList.C.

References Foam::constant::physicoChemical::b.

◆ force()

Foam::scalar force ( const label  a,
const label  b,
const scalar  rIJMag 
) const

Definition at line 312 of file pairPotentialList.C.

References Foam::constant::physicoChemical::b, and f().

Here is the call graph for this function:

◆ energy()

Foam::scalar energy ( const label  a,
const label  b,
const scalar  rIJMag 
) const

◆ electrostatic()

const Foam::pairPotential & electrostatic ( ) const
inline

Definition at line 74 of file pairPotentialListI.H.


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