DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 > Class Template Reference

#include <DoublePadeDelay.h>

Inheritance diagram for DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >:

Public Member Functions
virtual void	calc (const double t, const double *x, const unsigned lenX, double *derivative)
virtual DoublePadeDelay *	clone () const
unsigned	controlNode () const
	DoublePadeDelay (const unsigned padeRow1, const unsigned padeColumn1, const unsigned padeRow2, const unsigned padeColumn2)
	DoublePadeDelay (const unsigned padeRow1, const unsigned padeColumn1, const unsigned padeRow2, const unsigned padeColumn2, const HcalInterpolatedPulse &pulse)
unsigned	nParameters () const
unsigned	numberOfNodes () const
unsigned	outputNode () const
Public Member Functions inherited from AbsElectronicODERHS
	AbsElectronicODERHS ()
	AbsElectronicODERHS (const HcalInterpolatedPulse &pulse)
bool	allParametersSet () const
const std::vector< double > &	getAllParameters () const
double	getParameter (const unsigned which) const
const HcalInterpolatedPulse &	inputPulse () const
HcalInterpolatedPulse &	inputPulse ()
template<class Pulse >
void	setInputPulse (const Pulse &pulse)
void	setLeadingParameters (const double *values, const unsigned len)
void	setLeadingParameters (const std::vector< double > &values)
void	setParameter (const unsigned which, const double value)
virtual	~AbsElectronicODERHS ()
Public Member Functions inherited from AbsODERHS
virtual	~AbsODERHS ()

Private Member Functions
void	validate () const

Private Attributes
ODE1	ode1_
ODE2	ode2_
DelayTimeModel1	tau1_
DelayTimeModel2	tau2_

Static Private Attributes
static const unsigned	thisCodeNumPars = 3U

Additional Inherited Members
Static Public Attributes inherited from AbsElectronicODERHS
static const unsigned	invalidNode = UINT_MAX - 1U
Protected Attributes inherited from AbsElectronicODERHS
HcalInterpolatedPulse	inputPulse_
std::vector< double >	params_

Detailed Description

template<class ODE1, class ODE2, class DelayTimeModel1, class DelayTimeModel2>
class DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >

Definition at line 17 of file DoublePadeDelay.h.

Constructor & Destructor Documentation

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::DoublePadeDelay ( const unsigned  padeRow1, const unsigned  padeColumn1, const unsigned  padeRow2, const unsigned  padeColumn2  )

inline

Definition at line 20 of file DoublePadeDelay.h.

References DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::validate().

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::clone().

        : ode1_(padeRow1, padeColumn1), ode2_(padeRow2, padeColumn2)
    {
        validate();
    }

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::DoublePadeDelay ( const unsigned  padeRow1, const unsigned  padeColumn1, const unsigned  padeRow2, const unsigned  padeColumn2, const HcalInterpolatedPulse &  pulse  )

inline

Definition at line 27 of file DoublePadeDelay.h.

References DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::validate().

        : AbsElectronicODERHS(pulse),
          ode1_(padeRow1, padeColumn1),
          ode2_(padeRow2, padeColumn2)
    {
        validate();
    }

Member Function Documentation

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

virtual void DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::calc ( const double  t, const double *  x, const unsigned  lenX, double *  derivative  )

inlinevirtual

Implements AbsODERHS.

Definition at line 40 of file DoublePadeDelay.h.

References AbsElectronicODERHS::allParametersSet(), assert(), DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::controlNode(), InterpolatedPulse< MaxLen >::derivative(), edm::hlt::Exception, AbsElectronicODERHS::inputPulse_, AbsElectronicODERHS::invalidNode, bookConverter::max, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode1_, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode2_, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::outputNode(), AbsElectronicODERHS::params_, InterpolatedPulse< MaxLen >::secondDerivative(), metsig::tau, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::tau1_, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::tau2_, and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::thisCodeNumPars.

    {
        if (!allParametersSet()) throw cms::Exception(
            "In DoublePadeDelay::calc: timing and/or ODE parameters not set");

        // The input signal
        const double currentIn = inputPulse_(t);

        // The output signal
        const double currentOut = x[outputNode()];

        // Numbers of parameters used by the member objects
        const unsigned npTau1 = tau1_.nParameters();
        const unsigned npOde1 = ode1_.nParameters();
        const unsigned npTau2 = tau2_.nParameters();
        const unsigned npOde2 = ode2_.nParameters();

        // Parameters for this code.
        // Order of parameters in the overall parameter set is:
        // parameters for tau1, then for ode1, then tau2, then ode2,
        // then parameters of this code.
        const double* pstart = &params_[npTau1 + npOde1 + npTau2 + npOde2];
        const double* pars = pstart;
        const double ctlGainOut = *pars++;
        const double inGainOut  = *pars++;
        const double outGainOut = *pars++;
        assert(thisCodeNumPars == static_cast<unsigned>(pars - pstart));

        // Save a little bit of time by not calculating the input
        // signal derivatives in case they will not be needed
        const unsigned row = std::max(ode1_.getPadeRow(), ode2_.getPadeRow());
        const double dIdt = row ? inputPulse_.derivative(t) : 0.0;
        const double d2Id2t = row > 1U ? inputPulse_.secondDerivative(t) : 0.0;

        // Set the timing parameters of the control circuit
        unsigned firstPar = npTau1 + npOde1;
        const double tau2 = tau2_(currentIn, &params_[firstPar], npTau2);

        // Set the ODE parameters for the control circuit
        firstPar += npTau2;
        if (npOde2)
            ode2_.setParameters(&params_[firstPar], npOde2);

        // Run the control circuit
        const unsigned ctrlNode = controlNode();
        double control;
        if (ctrlNode < AbsElectronicODERHS::invalidNode)
        {
            // The control circuit solves an ODE
            control = x[ctrlNode];
            ode2_.calculate(tau2, currentIn, dIdt, d2Id2t,
                            x, lenX, ctrlNode, derivative);
        }
        else
        {
            // The control circuit does not solve an ODE.
            // Instead, it drives its output directly.
            ode2_.calculate(tau2, currentIn, dIdt, d2Id2t,
                            0, 0U, 0U, &control);
        }

        // Timing parameter for the output circuit (the preamp)
        const double vtau = ctlGainOut*control   +
                             inGainOut*currentIn + 
                            outGainOut*currentOut;
        const double tau = tau1_(vtau, &params_[0], npTau1);

        // ODE parameters for the output circuit
        if (npOde1)
            ode1_.setParameters(&params_[npTau1], npOde1);

        // Run the output circuit
        ode1_.calculate(tau, currentIn, dIdt, d2Id2t, x, lenX, 0U, derivative);
    }

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

virtual DoublePadeDelay* DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::clone ( void  ) const

inlinevirtual

Implements AbsODERHS.

Definition at line 37 of file DoublePadeDelay.h.

References DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::DoublePadeDelay().

        {return new DoublePadeDelay(*this);}

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

unsigned DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::controlNode ( ) const

inlinevirtual

Reimplemented from AbsElectronicODERHS.

Definition at line 133 of file DoublePadeDelay.h.

References AbsElectronicODERHS::invalidNode, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode1_, and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode2_.

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::calc().

    {
        if (ode2_.getPadeColumn())
            // ode2 has a real output node
            return ode1_.getPadeColumn();
        else
            // ode2 does not have a real output node
            return AbsElectronicODERHS::invalidNode;
    }

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

unsigned DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::nParameters ( ) const

inlinevirtual

Implements AbsElectronicODERHS.

Definition at line 120 of file DoublePadeDelay.h.

References DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode1_, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode2_, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::tau1_, DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::tau2_, and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::thisCodeNumPars.

    {
        const unsigned npTau1 = tau1_.nParameters();
        const unsigned npOde1 = ode1_.nParameters();
        const unsigned npTau2 = tau2_.nParameters();
        const unsigned npOde2 = ode2_.nParameters();
        return npTau1 + npOde1 + npTau2 + npOde2 + thisCodeNumPars;
    }

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

unsigned DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::numberOfNodes ( ) const

inlinevirtual

Implements AbsElectronicODERHS.

Definition at line 117 of file DoublePadeDelay.h.

References DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode1_, and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode2_.

        {return ode1_.getPadeColumn() + ode2_.getPadeColumn();}

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

unsigned DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::outputNode ( ) const

inlinevirtual

Implements AbsElectronicODERHS.

Definition at line 129 of file DoublePadeDelay.h.

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::calc().

{return 0U;}

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

void DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::validate ( ) const

inlineprivate

Definition at line 146 of file DoublePadeDelay.h.

References DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode1_.

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::DoublePadeDelay().

    {
        // Basically, we need to avoid the situation in which
        // we need to solve the differential equation for the control
        // circuit but do not need to solve the differential equation
        // for the preamp. It this case we will not have a good way
        // to pass the preamp output to the simulator. The simplest
        // way to ensure correctness of the whole procedure is to require
        // that the preamp must always be modeled by an ODE. Indeed,
        // one will almost surely need to represent it by at least
        // a low-pass filter.
        if (!ode1_.getPadeColumn()) throw cms::Exception(
            "In DoublePadeDelay::validate: the output "
            "circuit must be modeled by an ODE");
    }

Member Data Documentation

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

ODE1 DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode1_

private

Definition at line 162 of file DoublePadeDelay.h.

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::calc(), DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::controlNode(), DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::nParameters(), DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::numberOfNodes(), and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::validate().

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

ODE2 DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::ode2_

private

Definition at line 163 of file DoublePadeDelay.h.

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::calc(), DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::controlNode(), DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::nParameters(), and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::numberOfNodes().

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

DelayTimeModel1 DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::tau1_

private

Definition at line 164 of file DoublePadeDelay.h.

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::calc(), and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::nParameters().

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

DelayTimeModel2 DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::tau2_

private

Definition at line 165 of file DoublePadeDelay.h.

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::calc(), and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::nParameters().

template<class ODE1 , class ODE2 , class DelayTimeModel1 , class DelayTimeModel2 >

const unsigned DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::thisCodeNumPars = 3U

staticprivate

Definition at line 144 of file DoublePadeDelay.h.

Referenced by DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::calc(), and DoublePadeDelay< ODE1, ODE2, DelayTimeModel1, DelayTimeModel2 >::nParameters().