CODE documentation

Code documentation, its uses and internal structure

Classes

Below follows the different classes in CODE.

Sources

• Sources
• RosenbluthSource
• ChiuHarveySource

Operators

• Operator
• EquationSettings
• DiagonalPlusBoundaryCondition

Implicit Operators

• ImplicitOperator
• EfieldOperator
• CollisionOperator
• SynchrotronLoss
• MagneticDiffusionOperator
• Functions

Explicit Operators

• ExplicitOperator
• ImprovedChiuHarveySource
• Bremsstrahlung

Quantities

• State
• Reference
• PhysicalParams:
• MomentumGrid
• TimeGrid

Simulation

• Solver
• SmartLUSolver

Simulation output

• Output
• Distributions

Help functions

Below are different help functions located in CODElib folder documented.

• cs = CalculateMollerCS(g,g1)
• moment = CalculateRunawayMomentXiDependent(Nxi,Ny,f,xiIntMat,weightsMat)
• sigma = CalculateSigmaIntegral(gamma,gamma_m)
• [m,xiGrid] = GenerateCumIntMat(Nxi,nPoints)
• f = interpolateDistribution(dist,MG)
• outPls = LegendrePolynomials(l,x)
• [x,w] = lgwt(N,a,b)
• [x, w, D, DD] = m20121125_04_DifferentiationMatricesForUniformGrid(N, xMin, xMax, scheme)
• m = MapToXiIntMat(cumintMat,xiGrid,EOverEc,y2,deltaRef)
• [posF,negF] = SumLegModesAtXi1(f,Ny,Nxi)
• i = CalculateCurrentAlongB(f,y,yWeights, Ny, nRef ,deltaRef)
• n = CalculateDensity(f,Ny,Nxi,y,yWeights,nRef)
• delta = getDeltaFromT(T)
• [delta,lnLambda,collFreq,BHat] = getDerivedParameters(T,density,B)
• [EOverEC,EOverED,EHat] = getNormalizedEFields(E,T,density)
• sigma = GetSpitzerConductivity(T,n,Z)

Code internal structure

• Code description
  • Geneneral time concept
  • Structure of Common Variables
  • Equation

Indices and tables

• Index
• Module Index
• Search Page