LogScalarFunction Class Reference

#include <ScalarFunctionsImpl.h>

Inheritance diagram for LogScalarFunction:

Collaboration diagram for LogScalarFunction:

Public Member Functions
	LogScalarFunction (const doublereal &ml, const doublereal &b, const doublereal &c)
virtual	~LogScalarFunction (void)
virtual doublereal	operator() (const doublereal x) const
virtual doublereal	ComputeDiff (const doublereal t, const integer order=1) const
Public Member Functions inherited from DifferentiableScalarFunction
virtual	~DifferentiableScalarFunction ()
Public Member Functions inherited from BasicScalarFunction
virtual	~BasicScalarFunction ()

Private Attributes
const doublereal	mul_input
doublereal	mul_const
const doublereal	base
const doublereal	coef

Detailed Description

Definition at line 92 of file ScalarFunctionsImpl.h.

Constructor & Destructor Documentation

LogScalarFunction::LogScalarFunction	(	const doublereal &	ml,
		const doublereal &	b,
		const doublereal &	c
	)

Definition at line 281 of file ScalarFunctionsImpl.cc.

References grad::log(), and mul_const.

: mul_input(ml), mul_const(ml), base(b), coef(c)
{
        if (b != 1.) {
                mul_const /= log(b);
        }
}

Here is the call graph for this function:

LogScalarFunction::~LogScalarFunction ( void  )

virtual

Definition at line 292 of file ScalarFunctionsImpl.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

doublereal LogScalarFunction::ComputeDiff ( const doublereal  t, const integer  order = 1  ) const

virtual

Implements DifferentiableScalarFunction.

Definition at line 310 of file ScalarFunctionsImpl.cc.

References ASSERTMSGBREAK, MBDYN_EXCEPT_ARGS, mul_const, operator()(), and order.

{
        ASSERTMSGBREAK(order >= 0, "Error in LogScalarFunction::ComputeDiff, order<0");
        if (order == 0) {
                return this->operator()(x);
        }

        if (x <= 0.) {
                silent_cerr("LogScalarFunction: argument must be positive" << std::endl);
                throw DataManager::ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        /*
         *

 d^i                                                                mul_const
 ---  ( mul_const * log( coef * x ) ) = - ( -1 ) ^ i * ( i - 1 )! * ---------
 dx^i                                                                  x^i

         *
         */

        doublereal d = mul_const/x;
        for (int i = 1; i < order; i++) {
                d *= -i/x;
        }

        return d;
}

Here is the call graph for this function:

doublereal LogScalarFunction::operator() ( const doublereal  x ) const

virtual

Implements DifferentiableScalarFunction.

Definition at line 298 of file ScalarFunctionsImpl.cc.

References coef, grad::log(), MBDYN_EXCEPT_ARGS, and mul_const.

Referenced by ComputeDiff().

{
        doublereal xx = coef*x;
        if (xx <= 0.) {
                silent_cerr("LogScalarFunction: argument must be positive" << std::endl);
                throw DataManager::ErrGeneric(MBDYN_EXCEPT_ARGS);
        }

        return log(xx)*mul_const;
}

Here is the call graph for this function:

Member Data Documentation

const doublereal LogScalarFunction::base

private

Definition at line 96 of file ScalarFunctionsImpl.h.

const doublereal LogScalarFunction::coef

private

Definition at line 97 of file ScalarFunctionsImpl.h.

Referenced by operator()().

doublereal LogScalarFunction::mul_const

private

Definition at line 95 of file ScalarFunctionsImpl.h.

Referenced by ComputeDiff(), LogScalarFunction(), and operator()().

const doublereal LogScalarFunction::mul_input

private

Definition at line 94 of file ScalarFunctionsImpl.h.

---

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

• ScalarFunctionsImpl.h
• ScalarFunctionsImpl.cc