ocsReduOptAmplifier.hh

Go to the documentation of this file.

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

#ifndef _OCS_REDU_OPT_AMPLIFIER_HH_
#define _OCS_REDU_OPT_AMPLIFIER_HH_

#ifndef _OCS_TYPE_AMPLIFIER_
#define _OCS_TYPE_AMPLIFIER_

enum typeAmplifier { NO_AMPLIFICATION = 0,
                     SCALAR_SIMPLE = 1, SCALAR_SATURATED = 2, 
                     VECTOR_SIMPLE = 3, VECTOR_SATURATED = 4, 
                     VECTOR_FIXED_OUTPUT_POWER = 5,
                     VECTOR_FIXED_TOTAL_OUTPUT_POWER = 6 };

#ifndef _TYPE_AMPLIFIER_NOISE_
#define _TYPE_AMPLIFIER_NOISE_

enum typeAmplifierNoise { NOISE_OFF = 0, 
                          NOISE_ON_CONST_POWER_RANDOM_PHASE = 1,
                          NOISE_ON_GAUSSIAN_WHITE = 2, 
                          NOISE_ON_NO_RNG = 3,
                          NOISE_ON_SEMI_ANALYTICAL = 4, 
                          NOISE_ON_BIASED = 5}; 
                                                  
                                                          
#endif // _TYPE_AMPLIFIER_NOISE_

#endif /* _OCS_TYPE_AMPLIFIER_ */

#include "ocsReduOptSignal.hh"
#include "ocsReduPolDepAttenuator.hh"

// ##############################################
// #### Classes of objects for the reduced model
// ##############################################

// #### Class ReduOptAmplifier


class ReduOptAmplifier
{
   public:
  
 
     ReduOptAmplifier( string InFileName,
                    ReduOptSignal *oReduOptSignalTmp);


      ~ReduOptAmplifier();   


      void SetFixedOutputPowerFromCurrentOptSignal(void);
      void SetFixedTotalOutputPowerFromCurrentOptSignal(void)
           {SetFixedOutputPowerFromCurrentOptSignal();};


      void AmplifyOptSignal(void);     

  // ! \sa typeAmplifier TypeAmplifier

      void SetTypeAmplifier(typeAmplifier TypeAmplifier2);

      typeAmplifier GetTypeAmplifier(void)
             {return TypeAmplifier;};

// ! \sa typeAmplifierNoise TypeAmplifierNoise

      void SetTypeAmplifierNoise(typeAmplifierNoise TypeAmplifierNoise2);

      void SetPolDepGain(double PolDepGainOptAmplifier2)
              {PolDepGainOptAmplifier = PolDepGainOptAmplifier2;};

      void SetGain(double dBGain2);

      double SteadyStateSaturatedGain(double InputPower);

      void SetGainCompressionSaturatedAmplifier(
                   double GainTarget_dB, double GainCompression_dB, 
                   double OutputPowerTarget);


      void SyncNumChannels(void);
      
// ! \sa typeAmplifier TypeAmplifier

      string WriteTypeAmplifier(void);

// ! \sa typeAmplifierNoise TypeAmplifierNoise

      string WriteTypeAmplifierNoise(void);


      void WriteSteadyStateGainVersusPower(string OutFileName,
                       double InputPowerMaxLinear, int NumPowerSteps);


      void WriteSteadyInputPowerVersusOutputPower(string OutFileName,
                   double InputPowerMaxLinear, int NumPowerSteps);


      double GetSaturatingPowerLinear(void){return SaturatingPowerLinear;}; 

      double GetPolDepGain(void) 
                {return PolDepGainOptAmplifier;};

      double GetOutputPowerLinear(void)
             {return OutputPowerLinear;};
             
      double GetLinearGainOptAmplif(void)
            {return LinearGainOptAmplif;};           

   private:


      void AllocateNoiseAmplitudeChannels(void);


      void ReleaseMemory(void);



      void AddPolDepGainEffect(void);


      double GetGainFixedOutputPower(double InputPower);

      //double GetGainFixedOutputPowerDiffNoise( double InputPower);


      ReduOptSignal *oReduOptSignal;


      ReduPolDepAttenuator *oReduPolDepAttenuator;



      //double PolarizNoiseBandwidth;

      double StokesSignalTmp[4];
      double StokesNoiseTmp[4];           

      double CenterFreq;
      double ChannSpacing;
      int    NumChannels;

      double dBGain;         



      double OutputPowerLinear;


      double PolDepGainOptAmplifier;   

      double LinearGainOptAmplif; 
  
      double NoiseFigOptAmplifier;
      double LinearNoiseFigOptAmplif;
      double SpontaneousEmissionFactor;

      // ## variables for the saturation model 

      double AmpLength;  
      int NumZSteps;
      double SaturatingPower;
      double SaturatingPowerLinear;
      double SaturatingPowerdBm;
      double UnsaturatedGaindB;
      double UnsaturatedGainLinear;
      double UnsaturatedDifferentialGainLinear;


      double *NormalizedNoiseAmplitude;


      typeAmplifier TypeAmplifier;
    

      typeAmplifierNoise TypeAmplifierNoise;
    
      int DebugLevel;
};

#endif //_OCS_REDU_OPT_AMPLIFIER_HH_