sigmoid Class Reference

#include <potential/sigmoid.H>

---

Detailed Description

Source files

• src/lagrangian/molecularDynamics/potential/energyScalingFunction/derived/sigmoid/sigmoid.H
• src/lagrangian/molecularDynamics/potential/energyScalingFunction/derived/sigmoid/sigmoid.C

Definition at line 51 of file sigmoid.H.

Inheritance diagram for sigmoid:

Collaboration diagram for sigmoid:

List of all members.

Public Member Functions
	TypeName ("sigmoid")
	Runtime type information.
	sigmoid (const word &name, const dictionary &energyScalingFunctionProperties, const pairPotential &pairPot)
	Construct from components.
	~sigmoid ()
void	scaleEnergy (scalar &e, const scalar r) const
bool	read (const dictionary &energyScalingFunctionProperties)
	Read dictionary.

---

Constructor & Destructor Documentation

sigmoid	(	const word &	name,
		const dictionary &	energyScalingFunctionProperties,
		const pairPotential &	pairPot
	)

Construct from components.

Definition at line 64 of file sigmoid.C.

~sigmoid

(

)

[inline]

Definition at line 92 of file sigmoid.H.

---

Member Function Documentation

TypeName

(

"sigmoid"

)

Runtime type information.

void scaleEnergy	(	scalar &	e,
		const scalar	r
	)		const [virtual]

Implements energyScalingFunction.

Definition at line 82 of file sigmoid.C.

bool read

(

const dictionary &

energyScalingFunctionProperties  )

[virtual]

Read dictionary.

Implements energyScalingFunction.

Definition at line 88 of file sigmoid.C.

References dictionary::lookup(), and dictionary::subDict().

---

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

• src/lagrangian/molecularDynamics/potential/energyScalingFunction/derived/sigmoid/sigmoid.H
• src/lagrangian/molecularDynamics/potential/energyScalingFunction/derived/sigmoid/sigmoid.C