Inheritance diagram for tetherPotentialList:

Collaboration diagram for tetherPotentialList:

Public Member Functions
	tetherPotentialList ()

	tetherPotentialList (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList)
	Construct from siteIdList and potental dictionaries. More...

	~tetherPotentialList ()
	Destructor. More...

void	buildPotentials (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList)

const List< word > &	idMap () const

const tetherPotential &	tetherPotentialFunction (const label a) const

vector	force (const label a, const vector rIT) const

scalar	energy (const label a, const vector rIT) const

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

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

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

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

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

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

	PtrList (const SLPtrList< T > &)
	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 ()

	PtrList (const label s)

	PtrList (const PtrList< T > &a)

	PtrList (const Xfer< PtrList< T > > &lst)

	PtrList (PtrList< T > &a, bool reUse)

	PtrList (const SLPtrList< T > &sll)

	PtrList (Istream &is)

	~PtrList ()
	Destructor. More...

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

bool	empty () const
	Return true if the PtrList 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 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 (T *)
	Append an element at the end of the list. More...

void	append (const autoPtr< T > &)

void	append (const tmp< T > &)

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

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

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

autoPtr< T >	set (const label, T *)
	Set element. Return old element (can be NULL). More...

autoPtr< T >	set (const label, const autoPtr< T > &)

autoPtr< T >	set (const label, const tmp< T > &)

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

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

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

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

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

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

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

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

Private Member Functions
label	tetherPotentialIndex (const label a) const

void	readTetherPotentialDict (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList)

void	operator= (const tetherPotentialList &)
	Disallow default bitwise assignment. More...

	tetherPotentialList (const tetherPotentialList &)
	Disallow default bitwise copy construct. More...

Private Attributes
List< label >	idMap_

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

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

Data Fields inherited from PtrList< tetherPotential >
const typedef T &	const_reference
	Type that can be used for storing into constant PtrList::value_type. More...

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

Detailed Description

Source files

Definition at line 50 of file tetherPotentialList.H.

Constructor & Destructor Documentation

◆ tetherPotentialList() [1/3]

tetherPotentialList ( const tetherPotentialList & )

private

Disallow default bitwise copy construct.

◆ tetherPotentialList() [2/3]

tetherPotentialList ( )

Definition at line 87 of file tetherPotentialList.C.

◆ tetherPotentialList() [3/3]

tetherPotentialList	(	const List< word > &	siteIdList,
		const dictionary &	tetherPotentialDict,
		const List< word > &	tetherSiteIdList
	)

Construct from siteIdList and potental dictionaries.

Definition at line 95 of file tetherPotentialList.C.

◆ ~tetherPotentialList()

~tetherPotentialList ( )

Destructor.

Definition at line 110 of file tetherPotentialList.C.

Member Function Documentation

◆ tetherPotentialIndex()

Foam::label tetherPotentialIndex ( const label a ) const

inlineprivate

Definition at line 29 of file tetherPotentialListI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ readTetherPotentialDict()

void readTetherPotentialDict	(	const List< word > &	siteIdList,
		const dictionary &	tetherPotentialDict,
		const List< word > &	tetherSiteIdList
	)

private

Definition at line 31 of file tetherPotentialList.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::findIndex(), forAll, dictionary::found(), Foam::Info, Foam::compressible::New(), Foam::nl, List::size(), and dictionary::subDict().

Here is the call graph for this function:

◆ operator=()

void operator= ( const tetherPotentialList & )

private

Disallow default bitwise assignment.

◆ buildPotentials()

void buildPotentials	(	const List< word > &	siteIdList,
		const dictionary &	tetherPotentialDict,
		const List< word > &	tetherSiteIdList
	)

Definition at line 117 of file tetherPotentialList.C.

References setSize(), and List::size().

Here is the call graph for this function:

◆ idMap()

const List<word>& idMap ( ) const

inline

◆ tetherPotentialFunction()

const Foam::tetherPotential & tetherPotentialFunction ( const label a ) const

Definition at line 130 of file tetherPotentialList.C.

◆ force()

Foam::vector force	(	const label	a,
		const vector	rIT
	)		const

Definition at line 139 of file tetherPotentialList.C.

Referenced by moleculeCloud::calculateTetherForce().

Here is the caller graph for this function:

◆ energy()

Foam::scalar energy	(	const label	a,
		const vector	rIT
	)		const

Definition at line 149 of file tetherPotentialList.C.

Referenced by moleculeCloud::calculateTetherForce().

Here is the caller graph for this function:

Field Documentation

◆ idMap_

List<label> idMap_

private

Definition at line 56 of file tetherPotentialList.H.

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

src/lagrangian/molecularDynamics/potential/tetherPotential/tetherPotentialList/tetherPotentialList.H
src/lagrangian/molecularDynamics/potential/tetherPotential/tetherPotentialList/tetherPotentialList.C
src/lagrangian/molecularDynamics/potential/tetherPotential/tetherPotentialList/tetherPotentialListI.H

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ tetherPotentialList() [1/3]

◆ tetherPotentialList() [2/3]

◆ tetherPotentialList() [3/3]

◆ ~tetherPotentialList()

Member Function Documentation

◆ tetherPotentialIndex()

◆ readTetherPotentialDict()

◆ operator=()

◆ buildPotentials()

◆ idMap()

◆ tetherPotentialFunction()

◆ force()

◆ energy()

Field Documentation

◆ idMap_