SaturableAbsorber.hh

Go to the documentation of this file.

// $Id:

//###################################################################
//
//           Optical Communication Systems Simulator
//
//       Copyright (2009)
//       Optical Fiber Communications Laboratory (OFCL)
//       Computer Science & Electrical Engineering Department (CSEE)
//       University of Maryland Baltimore County (UMBC)
//
//###################################################################

#ifndef _SATURABLE_ABSORBER_HH_
#define _SATURABLE_ABSORBER_HH_

#include "ocsOptSignal.hh"
#include "ocsOptFiberLocalError.hh"

// Written by John Zweck August 2009.


enum typeSaturableAbsorption {NO_SAT_ABS=0,
                              QUADRATIC_NO_LOSS_ANALYTIC=1,
                              QUADRATIC_NO_LOSS=2,
                              QUADRATIC_WITH_LOSS_ANALYTIC=3,
                              QUADRATIC_WITH_LOSS=4,
                              RATIONAL_QUADRATIC=5,
                              COUPLED_ODE=6};


class SaturableAbsorber
{
   public:

   SaturableAbsorber(string InFileName, OptSignal *oOptSignal2);

   void Apply(double  * PropagatedLength);

   string WriteTypeSaturableAbsorption(void);
   string WriteTypeStepSizes(void);

   private:
   
   void ApplyQuadraticNoLossAnalytic(void);
   void ApplyQuadraticWithLossAnalytic(void);

   void ApplyHeunsMethod(void);

   void ApplyHeunsMethodConstantSteps(void);
   void ApplyHeunsMethodLocalError(void);

   void ApplyHeunsSingleStep(double StepSizeZ);
   void ComputeSAFunction(cplx * U_XIn, cplx * U_YIn, double * SAFOut);

   double RungaKutta4Step(cplx* U_XIn, cplx * U_YIn,
                          double x_in, int time_index_in);

   double FastSaturableAbsorptionFunction(cplx u);
   double CoupledODESatAbsFunction(double Power,double loss);

   void UpdateTime(void);
   void UpdateFreq(void);
   void ComputeDeltaZMax(void);
   double ComputeRelativeError(void);
   void CopyFftMatricesTimeData(fftMatrices * OrigData,
                                fftMatrices * CopyOfData);


   typeSimulation TypeSimulation;
   OptSignal * oOptSignal;
   cfftw *fft;
   fftMatrices sfftM;
   int qtPoints;

   int DebugFlag;

   typeSaturableAbsorption TypeSaturableAbsorption;


   double SaturableAbsorberLength;

   double FastSaturableAbsorptionNonlinearCoefficient;

   double FastSaturableAbsorptionAttenuationCoefficient;


   double CoupledODEUnsaturatedNepperLoss;


   double CoupledODERelaxationTime;


   double CoupledODESaturationPower;


   typeStepSizes TypeStepSizes;

   int NumSteps;
   
   double RelativeErrorGoal;
   double DeltaZMaxInfile;
   double DeltaZMax;
   double DeltaZInitial;
   bool InitializedDeltaZInitialFlag;

   fftMatrices sfftM_Start;
   fftMatrices sfftM_Coarse;
   cplx * LaserWorkX;
   cplx * LaserWorkY;

   double * SAF1;
   double * SAF2;


};



#endif /* _SATURABLE_ABSORBER_HH_ */