TanhDriveCaller Class Reference

#include <drive_.h>

Inheritance diagram for TanhDriveCaller:

Collaboration diagram for TanhDriveCaller:

Public Member Functions
	TanhDriveCaller (const DriveHandler *pDH, doublereal ds, doublereal da, doublereal db, doublereal di)
	~TanhDriveCaller (void)
virtual DriveCaller *	pCopy (void) const
virtual std::ostream &	Restart (std::ostream &out) const
doublereal	dGet (const doublereal &dVar) const
virtual bool	bIsDifferentiable (void) const
virtual doublereal	dGetP (const doublereal &dVar) const
Public Member Functions inherited from DriveCaller
	DriveCaller (const DriveHandler *pDH)
virtual	~DriveCaller (void)
virtual doublereal	dGet (void) const
virtual doublereal	dGetP (void) const
virtual void	SetDrvHdl (const DriveHandler *pDH)
virtual const DriveHandler *	pGetDrvHdl (void) const
virtual void	Output (OutputHandler &OH) const
virtual void	Trace (OutputHandler &OH) const
Public Member Functions inherited from WithLabel
	WithLabel (unsigned int uL=0, const std::string &sN="")
virtual	~WithLabel (void)
void	PutLabel (unsigned int uL)
void	PutName (const std::string &sN)
unsigned int	GetLabel (void) const
const std::string &	GetName (void) const
Public Member Functions inherited from ToBeOutput
	ToBeOutput (flag fOut=fDefaultOut)
virtual	~ToBeOutput (void)
virtual void	OutputPrepare (OutputHandler &OH)
virtual void	Output (OutputHandler &OH, const VectorHandler &X, const VectorHandler &XP) const
virtual flag	fToBeOutput (void) const
virtual bool	bToBeOutput (void) const
virtual void	SetOutputFlag (flag f=flag(1))
Public Member Functions inherited from Traceable
	Traceable (flag fTrace=0)
virtual	~Traceable (void)
virtual flag	fToBeTraced (void) const
virtual void	SetTraceFlag (flag f=TRACE)

Private Attributes
doublereal	dStart
doublereal	dA
doublereal	dB
doublereal	dInitialValue

Additional Inherited Members
Public Types inherited from DriveCaller
enum	OutputFlags { OUTPUT_VALUE = OUTPUT_PRIVATE << 0, OUTPUT_DERIVATIVE = OUTPUT_PRIVATE << 1 }
enum	TraceFlags { TRACE_VALUE = TRACE_PRIVATE << 0, TRACE_DERIVATIVE = TRACE_PRIVATE << 1 }
Public Types inherited from ToBeOutput
enum	{ OUTPUT = 0x1U, OUTPUT_MASK = 0xFU, OUTPUT_PRIVATE = 0x10U, OUTPUT_PRIVATE_MASK = ~OUTPUT_MASK }
Public Types inherited from Traceable
enum	{ TRACE = 0x01U, TRACE_PUBLIC_MASK = 0x0FU, TRACE_PRIVATE = 0x10U, TRACE_PRIVATE_MASK = ~TRACE_PUBLIC_MASK }
Protected Attributes inherited from DriveCaller
DriveHandler *	pDrvHdl
Protected Attributes inherited from WithLabel
unsigned int	uLabel
std::string	sName
Protected Attributes inherited from ToBeOutput
flag	fOutput

Detailed Description

Definition at line 916 of file drive_.h.

Constructor & Destructor Documentation

TanhDriveCaller::TanhDriveCaller	(	const DriveHandler *	pDH,
		doublereal	ds,
		doublereal	da,
		doublereal	db,
		doublereal	di
	)

Definition at line 751 of file drive_.cc.

References NO_OP.

Referenced by pCopy().

: DriveCaller(pDH),
dStart(ds), dA(da), dB(db), dInitialValue(di)
{
        NO_OP;
}

TanhDriveCaller::~TanhDriveCaller

(

void

)

Definition at line 760 of file drive_.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

bool TanhDriveCaller::bIsDifferentiable ( void  ) const

inlinevirtual

Reimplemented from DriveCaller.

Definition at line 948 of file drive_.h.

{
        return true;
}

doublereal TanhDriveCaller::dGet ( const doublereal &  dVar ) const

inlinevirtual

Implements DriveCaller.

Definition at line 942 of file drive_.h.

References dA, dB, dInitialValue, dStart, and grad::tanh().

{
        return dInitialValue + dA*std::tanh(dB*(dVar - dStart));
}

Here is the call graph for this function:

doublereal TanhDriveCaller::dGetP ( const doublereal &  dVar ) const

inlinevirtual

Reimplemented from DriveCaller.

Definition at line 954 of file drive_.h.

References dA, dB, dStart, and grad::tanh().

{
        return dA*dB*(1. - std::tanh(dB*(dVar - dStart)));
}

Here is the call graph for this function:

DriveCaller * TanhDriveCaller::pCopy ( void  ) const

virtual

Implements DriveCaller.

Definition at line 767 of file drive_.cc.

References dA, dB, dInitialValue, dStart, DriveCaller::pDrvHdl, SAFENEWWITHCONSTRUCTOR, and TanhDriveCaller().

{
        DriveCaller* pDC = 0;
        SAFENEWWITHCONSTRUCTOR(pDC,
                TanhDriveCaller,
                TanhDriveCaller(pDrvHdl, dStart, dA, dB, dInitialValue));
        return pDC;
}

Here is the call graph for this function:

std::ostream & TanhDriveCaller::Restart ( std::ostream &  out ) const

virtual

Implements DriveCaller.

Definition at line 778 of file drive_.cc.

References dA, dB, dInitialValue, and dStart.

{
        return out
                << " tanh, " << dStart
                << ", " << dA
                << ", " << dB
                << ", " << dInitialValue;
}

Member Data Documentation

doublereal TanhDriveCaller::dA

private

Definition at line 919 of file drive_.h.

Referenced by dGet(), dGetP(), pCopy(), and Restart().

doublereal TanhDriveCaller::dB

private

Definition at line 920 of file drive_.h.

Referenced by dGet(), dGetP(), pCopy(), and Restart().

doublereal TanhDriveCaller::dInitialValue

private

Definition at line 921 of file drive_.h.

Referenced by dGet(), pCopy(), and Restart().

doublereal TanhDriveCaller::dStart

private

Definition at line 918 of file drive_.h.

Referenced by dGet(), dGetP(), pCopy(), and Restart().

---

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

• drive_.h
• drive_.cc