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 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 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 >
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< pairPotential >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

Foam::PtrList< pairPotential >	clone (Args &&... args) const

const pairPotential *	set (const label i) const

autoPtr< pairPotential >	set (const label i, pairPotential *ptr)
	Set element to given pointer and return old element (can be null) More...

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

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

autoPtr< pairPotential >	set (const label i, std::unique_ptr< pairPotential > &&ptr)
	Set element to given unique_ptr and return old element. More...

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

autoPtr< pairPotential >	set (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...

void	append (PtrList< pairPotential > &&other)
	Move append another list to the end of this list. More...

autoPtr< pairPotential >	emplace (const label i, Args &&... args)
	Construct and set an element. More...

Foam::autoPtr< pairPotential >	emplace (const label i, Args &&... args)

autoPtr< pairPotential >	release (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...

Public Member Functions inherited from UPtrList< T >
constexpr	UPtrList () noexcept
	Default construct. More...

	UPtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	UPtrList (const UPtrList< T > &list)
	Copy construct (shallow copies addresses) More...

	UPtrList (UPtrList< T > &&list)
	Move construct. More...

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

	UPtrList (PtrList< T > &list)
	Shallow copy from PtrList. More...

	UPtrList (const UList< T * > &list)
	Construct from UList of pointers (shallow copy) More...

	UPtrList (UList< T > &list)
	Construct from UList, taking the address of each list element. More...

label	size () const noexcept
	The number of elements in the list. More...

bool	empty () const noexcept
	True if the list 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...

const T *	test (const label i) const

T *	get (const label i)

const T *	get (const label i) const

const T *	set (const label i) const

void	clear ()
	Set list size to zero. More...

void	resize (const label newLen)
	Change the size of the list. More...

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

label	squeezeNull ()
	Squeeze out intermediate nullptr entries in the list of pointers. More...

void	append (T *ptr)
	Append an element to the end of the list. More...

void	append (UPtrList< T > &&other)
	Move append another list to the end of this list. More...

void	swap (UPtrList< T > &list)
	Swap content. More...

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

T *	set (const label i, T *ptr)

void	reorder (const labelUList &oldToNew, const bool check=false)

void	sortOrder (const labelUList &order, const bool check=false)

void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list. More...

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

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

const T *	operator() (const label i) const
	Return const pointer to the element - same as get(). More...

void	operator= (const UPtrList< T > &list)
	Copy assignment (shallow copies addresses) More...

void	operator= (UPtrList< T > &&list)
	Move assignment. More...

T **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution) More...

T **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution) More...

iterator	begin () noexcept
	Return an iterator to begin of UPtrList traversal. More...

iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	end () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

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

typedef T &	reference
	A non-const reference to the value_type. More...

typedef const T &	const_reference
	A const reference to the value_type. More...

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...

Protected Member Functions inherited from UPtrList< T >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size. More...

	UPtrList (Detail::PtrListDetail< T > &&ptrs)
	Low-level move construct. More...

Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< T >	ptrs_
	The list of pointers. More...

Detailed Description

Source files

Definition at line 53 of file pairPotentialList.H.

Constructor & Destructor Documentation

◆ pairPotentialList() [1/2]

pairPotentialList ( )

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 198 of file pairPotentialList.C.

References pairPotentialList::buildPotentials(), and mesh.

Here is the call graph for this function:

◆ ~pairPotentialList()

~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 219 of file pairPotentialList.C.

References mesh, setSize(), and UList< T >::size().

Referenced by 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 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 234 of file pairPotentialList.C.

References b.

◆ rCutSqr() [1/2]

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

Definition at line 255 of file pairPotentialList.C.

References b.

◆ rMin()

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

Definition at line 271 of file pairPotentialList.C.

References b.

◆ dr()

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

Definition at line 281 of file pairPotentialList.C.

References b.

◆ rCutSqr() [2/2]

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

Definition at line 291 of file pairPotentialList.C.

References b.

◆ rCut()

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

Definition at line 301 of file pairPotentialList.C.

References b.

◆ force()

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

Definition at line 311 of file pairPotentialList.C.

References 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

Definition at line 324 of file pairPotentialList.C.

References b, and e.

◆ 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:

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()