DriveCaller Class Reference

#include <drive.h>

Inheritance diagram for DriveCaller:

Collaboration diagram for DriveCaller:

Public Types
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 }

Public Member Functions
	DriveCaller (const DriveHandler *pDH)
virtual	~DriveCaller (void)
virtual DriveCaller *	pCopy (void) const =0
virtual std::ostream &	Restart (std::ostream &out) const =0
virtual doublereal	dGet (const doublereal &dVar) const =0
virtual doublereal	dGet (void) const
virtual bool	bIsDifferentiable (void) const
virtual doublereal	dGetP (const doublereal &dVar) 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)

Protected Attributes
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 442 of file drive.h.

Member Enumeration Documentation

enum DriveCaller::OutputFlags

Enumerator
OUTPUT_VALUE
OUTPUT_DERIVATIVE

Definition at line 447 of file drive.h.

                         {
                OUTPUT_VALUE      = OUTPUT_PRIVATE << 0,
                OUTPUT_DERIVATIVE = OUTPUT_PRIVATE << 1
        };

enum DriveCaller::TraceFlags

Enumerator
TRACE_VALUE
TRACE_DERIVATIVE

Definition at line 452 of file drive.h.

                        {
                TRACE_VALUE              = TRACE_PRIVATE << 0,
                TRACE_DERIVATIVE = TRACE_PRIVATE << 1
        };

Constructor & Destructor Documentation

DriveCaller::DriveCaller

(

const DriveHandler *

pDH

)

Definition at line 475 of file drive.cc.

References NO_OP.

: pDrvHdl(const_cast<DriveHandler *>(pDH))
{
        NO_OP;
}

DriveCaller::~DriveCaller ( void  )

virtual

Definition at line 481 of file drive.cc.

References NO_OP.

{
        NO_OP;
}

Member Function Documentation

bool DriveCaller::bIsDifferentiable ( void  ) const

inlinevirtual

Reimplemented in PostponedDriveCaller, PeriodicDriveCaller, DriveArrayCaller, PiecewiseLinearDriveCaller, DirectDriveCaller, ExpDriveCaller, FreqSweepDriveCaller, ScalarFunctionDriveCaller, FourierSeriesDriveCaller, TanhDriveCaller, CosineDriveCaller, SineDriveCaller, DoubleRampDriveCaller, ConstDriveCaller, OneDriveCaller, RampDriveCaller, NullDriveCaller, DoubleStepDriveCaller, StepDriveCaller, CubicDriveCaller, ParabolicDriveCaller, LinearDriveCaller, MultDriveCaller, TimeDriveCaller, NodeDistDriveCaller, GiNaCDriveCaller, SwitchDriveCaller, DriveDriveCaller, MultiStepDrive, MinMaxDriveCaller, and DummyDriveCaller.

Definition at line 495 of file drive.h.

Referenced by DriveOwner::bIsDifferentiable(), MultDriveCaller::bIsDifferentiable(), FreqSweepDriveCaller::bIsDifferentiable(), PeriodicDriveCaller::bIsDifferentiable(), drive(), Output(), DriveCallerRead::ReadOutput(), ReadVariableBody(), and Trace().

{
        return false;
}

virtual doublereal DriveCaller::dGet ( const doublereal &  dVar ) const

pure virtual

Implemented in PostponedDriveCaller, PeriodicDriveCaller, DriveArrayCaller, PiecewiseLinearDriveCaller, DirectDriveCaller, ClosestNextDriveCaller, MeterDriveCaller, RandDriveCaller, ExpDriveCaller, FreqSweepDriveCaller, ScalarFunctionDriveCaller, FourierSeriesDriveCaller, TanhDriveCaller, CosineDriveCaller, SineDriveCaller, DoubleRampDriveCaller, ConstDriveCaller, OneDriveCaller, RampDriveCaller, NullDriveCaller, DoubleStepDriveCaller, StepDriveCaller, CubicDriveCaller, ParabolicDriveCaller, LinearDriveCaller, MultDriveCaller, TimeStepDriveCaller, TimeDriveCaller, StringDriveCaller, FileDriveCaller, NodeDistDriveCaller, SwitchDriveCaller, GiNaCDriveCaller, MultiStepDrive, DriveDriveCaller, PrivDriveCaller, MinMaxDriveCaller, SHDriveCaller, DofDriveCaller, and DummyDriveCaller.

Referenced by TheodorsenAeroData::AfterConvergence(), DistanceJoint::AssJac(), DistanceJointWithOffset::AssJac(), Wheel4::AssJac(), ThermalSource::AssRes(), DistanceJoint::AssRes(), Control_valve::AssRes(), Wheel2::AssRes(), AbstractForce::AssRes(), DistanceJointWithOffset::AssRes(), TheodorsenAeroData::AssRes(), AbstractInternalForce::AssRes(), Dynamic_control_valve::AssRes(), Wheel4::AssRes(), Pressure_flow_control_valve::AssRes(), AxialRotationJoint::AssRes(), DofDriveCaller::dGet(), DriveDriveCaller::dGet(), PrivDriveCaller::dGet(), SwitchDriveCaller::dGet(), DriveOwner::dGet(), MultDriveCaller::dGet(), FreqSweepDriveCaller::dGet(), PeriodicDriveCaller::dGet(), ChangeStep::dGetNewStepTime(), MultDriveCaller::dGetP(), FreqSweepDriveCaller::dGetP(), ScalarDriveValue::dGetValue(), drive(), DrivenElem::DrivenElem(), StdAirProperties::GetAirProps(), DistanceJoint::InitialAssJac(), DistanceJointWithOffset::InitialAssJac(), DistanceJoint::InitialAssRes(), DistanceJointWithOffset::InitialAssRes(), AxialRotationJoint::InitialAssRes(), Motor::Motor(), DataManager::Output(), SolverDiagnostics::outputMeter(), AeroMemory::Predict(), Control_valve2::Prepare(), ReadVariableBody(), DistanceJoint::SetInitialValue(), DistanceJointWithOffset::SetInitialValue(), DistanceJoint::SetValue(), DistanceJointWithOffset::SetValue(), and BiStopCLWrapper< T, Tder >::Update().

doublereal DriveCaller::dGet ( void  ) const

inlinevirtual

Reimplemented in PostponedDriveCaller, PeriodicDriveCaller, DriveArrayCaller, ConstDriveCaller, OneDriveCaller, NullDriveCaller, MultDriveCaller, TimeStepDriveCaller, TimeDriveCaller, StringDriveCaller, NodeDistDriveCaller, DriveDriveCaller, PrivDriveCaller, SHDriveCaller, DofDriveCaller, MinMaxDriveCaller, and DummyDriveCaller.

Definition at line 489 of file drive.h.

References DriveHandler::dGetTime(), and Drive::pDrvHdl.

Referenced by Output(), and Trace().

{
        return dGet(pDrvHdl->dGetTime());
}

Here is the call graph for this function:

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

virtual

Reimplemented in PostponedDriveCaller, PeriodicDriveCaller, DriveArrayCaller, PiecewiseLinearDriveCaller, DirectDriveCaller, ExpDriveCaller, FreqSweepDriveCaller, ScalarFunctionDriveCaller, FourierSeriesDriveCaller, TanhDriveCaller, CosineDriveCaller, SineDriveCaller, DoubleRampDriveCaller, ConstDriveCaller, OneDriveCaller, RampDriveCaller, NullDriveCaller, DoubleStepDriveCaller, StepDriveCaller, CubicDriveCaller, ParabolicDriveCaller, LinearDriveCaller, MultDriveCaller, TimeDriveCaller, NodeDistDriveCaller, GiNaCDriveCaller, SwitchDriveCaller, MultiStepDrive, DriveDriveCaller, MinMaxDriveCaller, and DummyDriveCaller.

Definition at line 499 of file drive.cc.

References MBDYN_EXCEPT_ARGS.

Referenced by Wheel4::AssJac(), SwitchDriveCaller::dGetP(), DriveOwner::dGetP(), MultDriveCaller::dGetP(), FreqSweepDriveCaller::dGetP(), PeriodicDriveCaller::dGetP(), and drive().

{
        /* shouldn't get called if not differentiable,
         * or should be overridden if differentiable */
        throw ErrGeneric(MBDYN_EXCEPT_ARGS);
}

doublereal DriveCaller::dGetP ( void  ) const

inlinevirtual

Reimplemented in ConstDriveCaller, OneDriveCaller, NullDriveCaller, TimeDriveCaller, NodeDistDriveCaller, DriveDriveCaller, MinMaxDriveCaller, and DummyDriveCaller.

Definition at line 501 of file drive.h.

References DriveHandler::dGetTime(), and Drive::pDrvHdl.

Referenced by Output(), and Trace().

{
        return dGetP(pDrvHdl->dGetTime());
}

Here is the call graph for this function:

void DriveCaller::Output ( OutputHandler &  OH ) const

virtual

Reimplemented from ToBeOutput.

Definition at line 506 of file drive.cc.

References ASSERT, bIsDifferentiable(), dGet(), dGetP(), OutputHandler::DRIVECALLERS, OutputHandler::DriveCallers(), ToBeOutput::fToBeOutput(), WithLabel::GetLabel(), OUTPUT_DERIVATIVE, OUTPUT_VALUE, and OutputHandler::UseText().

{
        const flag fOut = fToBeOutput();

        if (fOut & flag(1)) {
                if (OH.UseText(OutputHandler::DRIVECALLERS)) {
                        std::ostream& os = OH.DriveCallers();

                        os << GetLabel();

                        if (fOut & OUTPUT_VALUE) {
                                os << ' ' << dGet();
                        }

                        if (fOut & OUTPUT_DERIVATIVE) {
                                ASSERT(bIsDifferentiable());

                                os << ' ' << dGetP();
                        }

                        os << std::endl;
                }
        }
}

Here is the call graph for this function:

virtual DriveCaller* DriveCaller::pCopy ( void  ) const

pure virtual

Implemented in PostponedDriveCaller, PeriodicDriveCaller, DriveArrayCaller, PiecewiseLinearDriveCaller, DirectDriveCaller, ClosestNextDriveCaller, MeterDriveCaller, RandDriveCaller, ExpDriveCaller, FreqSweepDriveCaller, ScalarFunctionDriveCaller, FourierSeriesDriveCaller, TanhDriveCaller, CosineDriveCaller, SineDriveCaller, DoubleRampDriveCaller, ConstDriveCaller, OneDriveCaller, RampDriveCaller, NullDriveCaller, DoubleStepDriveCaller, StepDriveCaller, CubicDriveCaller, ParabolicDriveCaller, LinearDriveCaller, MultDriveCaller, TimeStepDriveCaller, TimeDriveCaller, StringDriveCaller, FileDriveCaller, MaxDriveCaller, MinDriveCaller, SwitchDriveCaller, MultiStepDrive, NodeDistDriveCaller, GiNaCDriveCaller, DriveDriveCaller, PrivDriveCaller, DofDriveCaller, SHDriveCaller, and DummyDriveCaller.

Referenced by PostponedDriveCaller::Check(), MBDynParser::GetDriveCaller(), ChangeStep::Init(), Factor::Init(), DriveDriveCaller::pCopy(), MusclePennestriCL::pCopy(), MusclePennestriErgoCL::pCopy(), MusclePennestriReflexiveCL::pCopy(), MultDriveCaller::pCopy(), FreqSweepDriveCaller::pCopy(), ClosestNextDriveCaller::pCopy(), LTVViscoElasticGenericConstitutiveLaw< T, Tder >::pCopy(), PeriodicDriveCaller::pCopy(), BiStopCLWrapper< T, Tder >::pCopy(), InverseSolver::Prepare(), Solver::Prepare(), CompTDCR< T >::Read(), Solver::ReadData(), and ShockAbsorberConstitutiveLaw< doublereal, doublereal >::ShockAbsorberConstitutiveLaw().

const DriveHandler * DriveCaller::pGetDrvHdl ( void  ) const

virtual

Definition at line 493 of file drive.cc.

References pDrvHdl.

Referenced by PostponedDriveCaller::Check(), MultiStepDrive::pCopy(), and SwitchDriveCaller::pCopy().

{
        return pDrvHdl;
}

virtual std::ostream& DriveCaller::Restart ( std::ostream &  out ) const

pure virtual

Implemented in PostponedDriveCaller, PeriodicDriveCaller, DriveArrayCaller, PiecewiseLinearDriveCaller, DirectDriveCaller, ClosestNextDriveCaller, MeterDriveCaller, RandDriveCaller, ExpDriveCaller, FreqSweepDriveCaller, ScalarFunctionDriveCaller, FourierSeriesDriveCaller, TanhDriveCaller, CosineDriveCaller, SineDriveCaller, DoubleRampDriveCaller, ConstDriveCaller, OneDriveCaller, RampDriveCaller, NullDriveCaller, DoubleStepDriveCaller, StepDriveCaller, CubicDriveCaller, ParabolicDriveCaller, LinearDriveCaller, MultDriveCaller, TimeStepDriveCaller, TimeDriveCaller, FileDriveCaller, StringDriveCaller, NodeDistDriveCaller, SwitchDriveCaller, MultiStepDrive, GiNaCDriveCaller, DriveDriveCaller, PrivDriveCaller, SHDriveCaller, MinMaxDriveCaller, DofDriveCaller, and DummyDriveCaller.

Referenced by Vec3DriveOwner::Restart(), DofDriveCaller::Restart(), SHDriveCaller::Restart(), DriveDriveCaller::Restart(), PrivDriveCaller::Restart(), DistanceJoint::Restart(), LinearVelocityJoint::Restart(), DrivenElem::Restart(), Gust1D::Restart(), VariableBody::Restart(), MusclePennestriCL::Restart(), PowerLawWindProfile::Restart(), BasicAirProperties::Restart(), HydrodynamicPlainBearing::Restart(), Motor::Restart(), asynchronous_machine::Restart(), SingleTplDriveCaller< T >::Restart(), LogarithmicWindProfile::Restart(), StdAirProperties::Restart(), AbstractForce::Restart(), AngularVelocityJoint::Restart(), DistanceJointWithOffset::Restart(), SingleTplDriveCaller< doublereal >::Restart(), AbstractInternalForce::Restart(), MultDriveCaller::Restart(), AerodynamicBody::Restart(), UniformRotor::Restart(), Solver::Restart(), AerodynamicBeam::Restart(), AxialRotationJoint::Restart(), GlauertRotor::Restart(), AerodynamicBeam2::Restart(), ManglerRotor::Restart(), FreqSweepDriveCaller::Restart(), ClosestNextDriveCaller::Restart(), LTVViscoElasticGenericConstitutiveLaw< T, Tder >::Restart(), PeriodicDriveCaller::Restart(), PostponedDriveCaller::Restart(), BiStopCLWrapper< T, Tder >::Restart(), SingleTplDriveCaller< T >::Restart_int(), SingleTplDriveCaller< doublereal >::Restart_int(), and MusclePennestriReflexiveCL::Restart_int().

void DriveCaller::SetDrvHdl ( const DriveHandler *  pDH )

virtual

Definition at line 487 of file drive.cc.

References pDrvHdl.

Referenced by PostponedDriveCaller::Check(), InverseSolver::Prepare(), Solver::Prepare(), ChangeStep::SetDriveHandler(), TunableThirdOrderIntegrator::SetDriveHandler(), MultistepSolver::SetDriveHandler(), HopeSolver::SetDriveHandler(), and SolverDiagnostics::SetOutputDriveHandler().

{
        pDrvHdl = const_cast<DriveHandler *>(pDH);
}

void DriveCaller::Trace ( OutputHandler &  OH ) const

virtual

Implements Traceable.

Definition at line 531 of file drive.cc.

References ASSERT, bIsDifferentiable(), dGet(), dGetP(), Traceable::fToBeTraced(), Traceable::fTrace, WithLabel::GetLabel(), TRACE_DERIVATIVE, TRACE_VALUE, OutputHandler::TRACES, OutputHandler::Traces(), and OutputHandler::UseText().

{
        const flag fTrace = fToBeTraced();

        if (fTrace) {
                if (OH.UseText(OutputHandler::TRACES)) {
                        std::ostream& os = OH.Traces();

                        os << GetLabel();

                        if (fTrace & TRACE_VALUE) {
                                os << ' ' << dGet();
                        }

                        if (fTrace & TRACE_DERIVATIVE) {
                                ASSERT(bIsDifferentiable());

                                os << ' ' << dGetP();
                        }

                        os << std::endl;
                }
        }
}

Here is the call graph for this function:

Member Data Documentation

DriveHandler* DriveCaller::pDrvHdl

mutableprotected

Definition at line 444 of file drive.h.

Referenced by ClosestNextDriveCaller::ClosestNextDriveCaller(), SHDriveCaller::dGet(), StringDriveCaller::dGet(), TimeDriveCaller::dGet(), TimeStepDriveCaller::dGet(), RandDriveCaller::dGet(), MeterDriveCaller::dGet(), ClosestNextDriveCaller::dGet(), PeriodicDriveCaller::dGet(), MeterDriveCaller::MeterDriveCaller(), SHDriveCaller::pCopy(), DofDriveCaller::pCopy(), DriveDriveCaller::pCopy(), PrivDriveCaller::pCopy(), GiNaCDriveCaller::pCopy(), NodeDistDriveCaller::pCopy(), FileDriveCaller::pCopy(), StringDriveCaller::pCopy(), TimeDriveCaller::pCopy(), TimeStepDriveCaller::pCopy(), MultDriveCaller::pCopy(), LinearDriveCaller::pCopy(), ParabolicDriveCaller::pCopy(), CubicDriveCaller::pCopy(), StepDriveCaller::pCopy(), DoubleStepDriveCaller::pCopy(), RampDriveCaller::pCopy(), DoubleRampDriveCaller::pCopy(), SineDriveCaller::pCopy(), CosineDriveCaller::pCopy(), TanhDriveCaller::pCopy(), FourierSeriesDriveCaller::pCopy(), ScalarFunctionDriveCaller::pCopy(), FreqSweepDriveCaller::pCopy(), ExpDriveCaller::pCopy(), RandDriveCaller::pCopy(), MeterDriveCaller::pCopy(), ClosestNextDriveCaller::pCopy(), DirectDriveCaller::pCopy(), PiecewiseLinearDriveCaller::pCopy(), DriveArrayCaller::pCopy(), PeriodicDriveCaller::pCopy(), pGetDrvHdl(), RandDriveCaller::RandDriveCaller(), SHDriveCaller::Restart(), SetDrvHdl(), and SHDriveCaller::SHDriveCaller().

---

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

• drive.h
• drive.cc