Inheritance diagram for pairPotentialList:

Collaboration diagram for pairPotentialList:

Public Member Functions
	pairPotentialList ()

	pairPotentialList (const List< word > &idList, const dictionary &pairPotentialDict, const polyMesh &mesh)
	Construct from idList and potental 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 pairPotential &	pairPotentialFunction (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 pairPotential &	electrostatic () const

Public Member Functions inherited from PtrList< pairPotential >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< pairPotential > &)
	Copy constructor. More...

	PtrList (const PtrList< pairPotential > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (const Xfer< PtrList< pairPotential >> &)
	Construct by transferring the parameter contents. More...

	PtrList (PtrList< pairPotential > &, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< pairPotential > &)
	Construct as copy of SLPtrList<T> More...

	PtrList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	PtrList (Istream &)
	Construct from Istream using default Istream constructor class. More...

	~PtrList ()
	Destructor. More...

void	setSize (const label)
	Reset size of PtrList. If extending the PtrList, new entries are. More...

void	resize (const label)
	Alias for setSize(const label) More...

void	clear ()
	Clear the PtrList, i.e. set size to zero deleting all the. More...

void	append (pairPotential *)
	Append an element at the end of the list. More...

void	append (const autoPtr< pairPotential > &)

void	append (const tmp< pairPotential > &)

void	transfer (PtrList< pairPotential > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

Xfer< PtrList< pairPotential > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

autoPtr< pairPotential >	set (const label, pairPotential *)
	Set element to given T* and return old element (can be nullptr) More...

autoPtr< pairPotential >	set (const label, const autoPtr< pairPotential > &)
	Set element to given autoPtr<T> and return old element. More...

autoPtr< pairPotential >	set (const label, const tmp< pairPotential > &)
	Set element to given tmp<T> and return old element. More...

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

void	operator= (const PtrList< pairPotential > &)
	Assignment. More...

Public Member Functions inherited from UPtrList< T >
	UPtrList ()
	Null Constructor. More...

	UPtrList (const label)
	Construct with size specified. More...

	UPtrList (const Xfer< UPtrList< T >> &)
	Construct by transferring the parameter contents. More...

	UPtrList (UPtrList< T > &, bool reuse)
	Construct as copy or re-use as specified. More...

label	size () const
	Return the number of elements in the UPtrList. More...

bool	empty () const
	Return true if the UPtrList is empty (ie, size() is zero) More...

T &	first ()
	Return reference to the first element of the list. More...

const T &	first () const
	Return reference to first element of the list. More...

T &	last ()
	Return reference to the last element of the list. More...

const T &	last () const
	Return reference to the last element of the list. More...

void	setSize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	resize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	clear ()
	Clear the UPtrList, i.e. set size to zero. More...

void	transfer (UPtrList< T > &)
	Transfer the contents of the argument UPtrList into this. More...

Xfer< UPtrList< T > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

T *	set (const label, T *)
	Set element. Return old element (can be nullptr). More...

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

const T &	operator[] (const label) const
	Return element const reference. More...

T &	operator[] (const label)
	Return element reference. More...

const T *	operator() (const label) const
	Return element const pointer. More...

iterator	begin ()
	Return an iterator to begin traversing the UPtrList. More...

iterator	end ()
	Return an iterator to end traversing the UPtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the UPtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the UPtrList. More...

Additional Inherited Members
Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the UPtrList contains. More...

typedef T &	reference
	Type that can be used for storing into UPtrList::value_type objects. More...

typedef const T &	const_reference
	Type that can be used for storing into constant UPtrList::value_type. More...

Protected Member Functions inherited from PtrList< pairPotential >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Detailed Description

Source files

Definition at line 51 of file pairPotentialList.H.

Constructor & Destructor Documentation

◆ pairPotentialList() [1/2]

pairPotentialList ( )

Definition at line 189 of file pairPotentialList.C.

◆ pairPotentialList() [2/2]

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

Construct from idList and potental dictionaries.

Definition at line 196 of file pairPotentialList.C.

References pairPotentialList::buildPotentials().

Here is the call graph for this function:

◆ ~pairPotentialList()

~pairPotentialList ( )

Destructor.

Definition at line 210 of file pairPotentialList.C.

References pairPotentialList::buildPotentials().

Here is the call graph for this function:

Member Function Documentation

◆ buildPotentials()

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

Definition at line 217 of file pairPotentialList.C.

References pairPotentialList::pairPotentialFunction(), PtrList< pairPotential >::setSize(), and List< T >::size().

Referenced by pairPotentialList::pairPotentialList(), and pairPotentialList::~pairPotentialList().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rCutMax()

Foam::scalar rCutMax ( ) const

inline

Definition at line 61 of file pairPotentialListI.H.

◆ rCutMaxSqr() [1/2]

Foam::scalar rCutMaxSqr ( ) const

inline

Definition at line 67 of file pairPotentialListI.H.

◆ rCutMaxSqr() [2/2]

bool rCutMaxSqr ( scalar rIJMagSqr ) const

Definition at line 241 of file pairPotentialList.C.

References pairPotentialList::rCutSqr().

Here is the call graph for this function:

◆ pairPotentialFunction()

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

Definition at line 232 of file pairPotentialList.C.

Referenced by pairPotentialList::buildPotentials().

Here is the caller graph for this function:

◆ rCutSqr() [1/2]

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

Definition at line 255 of file pairPotentialList.C.

References pairPotentialList::rMin().

Referenced by pairPotentialList::dr(), and pairPotentialList::rCutMaxSqr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rMin()

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

Definition at line 273 of file pairPotentialList.C.

References pairPotentialList::dr().

Referenced by pairPotentialList::rCutSqr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dr()

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

Definition at line 283 of file pairPotentialList.C.

References pairPotentialList::rCutSqr().

Referenced by pairPotentialList::rMin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rCutSqr() [2/2]

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

Definition at line 293 of file pairPotentialList.C.

References pairPotentialList::rCut().

Here is the call graph for this function:

◆ rCut()

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

Definition at line 303 of file pairPotentialList.C.

References pairPotentialList::force().

Referenced by pairPotentialList::rCutSqr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ force()

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

Definition at line 313 of file pairPotentialList.C.

References pairPotentialList::energy(), and f().

Referenced by pairPotentialList::rCut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ energy()

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

Definition at line 326 of file pairPotentialList.C.

References Foam::e.

Referenced by pairPotentialList::force().

Here is the caller graph for this function:

◆ electrostatic()

const Foam::pairPotential & electrostatic ( ) const

inline

Definition at line 73 of file pairPotentialListI.H.

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

src/lagrangian/molecularDynamics/potential/pairPotential/pairPotentialList/pairPotentialList.H
src/lagrangian/molecularDynamics/potential/pairPotential/pairPotentialList/pairPotentialList.C
src/lagrangian/molecularDynamics/potential/pairPotential/pairPotentialList/pairPotentialListI.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ pairPotentialList() [1/2]

◆ pairPotentialList() [2/2]

◆ ~pairPotentialList()

Member Function Documentation

◆ buildPotentials()

◆ rCutMax()

◆ rCutMaxSqr() [1/2]

◆ rCutMaxSqr() [2/2]

◆ pairPotentialFunction()

◆ rCutSqr() [1/2]

◆ rMin()

◆ dr()

◆ rCutSqr() [2/2]

◆ rCut()

◆ force()

◆ energy()

◆ electrostatic()