Python Interface
API reference for the CSXCAD and openEMS Python modules. For installing them, see Python Interface.
- CSXCAD Python Interface
- CSXCAD
ContinuousStructureContinuousStructure.AddAbsorbingBC()ContinuousStructure.AddConductingSheet()ContinuousStructure.AddDiscMaterial()ContinuousStructure.AddDump()ContinuousStructure.AddExcitation()ContinuousStructure.AddLumpedElement()ContinuousStructure.AddMaterial()ContinuousStructure.AddMetal()ContinuousStructure.AddProbe()ContinuousStructure.AddProperty()ContinuousStructure.Clear()ContinuousStructure.DefineGrid()ContinuousStructure.DeleteProperty()ContinuousStructure.GetAllPrimitives()ContinuousStructure.GetAllProperties()ContinuousStructure.GetBackgroundMaterial()ContinuousStructure.GetCoordInputType()ContinuousStructure.GetGrid()ContinuousStructure.GetParameterSet()ContinuousStructure.GetPropertiesByName()ContinuousStructure.GetProperty()ContinuousStructure.GetPropertyByCoordPriority()ContinuousStructure.GetPropertyByType()ContinuousStructure.GetQtyPrimitives()ContinuousStructure.GetQtyProperties()ContinuousStructure.ReadFromXML()ContinuousStructure.RemoveProperty()ContinuousStructure.Reset()ContinuousStructure.SetMeshType()ContinuousStructure.Update()ContinuousStructure.Write2XML()ContinuousStructure.grid
- CSProperties
- Notes
- Examples
- CSProperties (Base Class)
CSPropertiesCSProperties.AddAttribute()CSProperties.AddBox()CSProperties.AddCurve()CSProperties.AddCylinder()CSProperties.AddCylindricalShell()CSProperties.AddLinPoly()CSProperties.AddMultiBox()CSProperties.AddPoint()CSProperties.AddPolygon()CSProperties.AddPolyhedron()CSProperties.AddPolyhedronReader()CSProperties.AddRotPoly()CSProperties.AddSphere()CSProperties.AddSphericalShell()CSProperties.AddWire()CSProperties.ExistAttribute()CSProperties.GetAttributeValue()CSProperties.GetCoordInputType()CSProperties.GetCopy()CSProperties.GetEdgeColor()CSProperties.GetFillColor()CSProperties.GetName()CSProperties.GetParameterSet()CSProperties.GetQtyPrimitives()CSProperties.GetType()CSProperties.GetTypeString()CSProperties.RemoveAttribute()CSProperties.SetAttributeValue()CSProperties.SetColor()CSProperties.SetCoordInputType()CSProperties.SetEdgeColor()CSProperties.SetFillColor()CSProperties.SetName()CSProperties.copy()CSProperties.fromType()CSProperties.fromTypeName()
- CSPropMaterial
- CSPropAbsorbingBC
- CSPropLumpedElement
CSPropLumpedElementCSPropLumpedElement.GetCapacity()CSPropLumpedElement.GetCaps()CSPropLumpedElement.GetDirection()CSPropLumpedElement.GetInductance()CSPropLumpedElement.GetLEtype()CSPropLumpedElement.GetResistance()CSPropLumpedElement.SetCapacity()CSPropLumpedElement.SetCaps()CSPropLumpedElement.SetDirection()CSPropLumpedElement.SetInductance()CSPropLumpedElement.SetLEtype()CSPropLumpedElement.SetResistance()
- CSPropMetal
- CSPropConductingSheet
- CSPropExcitation
CSPropExcitationCSPropExcitation.GetDelay()CSPropExcitation.GetEnabled()CSPropExcitation.GetExcitType()CSPropExcitation.GetExcitation()CSPropExcitation.GetFrequency()CSPropExcitation.GetPropagationDir()CSPropExcitation.GetWeightFile()CSPropExcitation.GetWeightFunction()CSPropExcitation.GetWeightOrigin()CSPropExcitation.GetWeightedExcitation()CSPropExcitation.SetDelay()CSPropExcitation.SetEnabled()CSPropExcitation.SetExcitType()CSPropExcitation.SetExcitation()CSPropExcitation.SetFrequency()CSPropExcitation.SetPropagationDir()CSPropExcitation.SetWeightFile()CSPropExcitation.SetWeightFunction()CSPropExcitation.SetWeightOrigin()
- CSPropProbeBox
CSPropProbeBoxCSPropProbeBox.AddFrequency()CSPropProbeBox.ClearFrequency()CSPropProbeBox.GetFrequency()CSPropProbeBox.GetFrequencyCount()CSPropProbeBox.GetModeFile()CSPropProbeBox.GetModeFunction()CSPropProbeBox.GetModeOrigin()CSPropProbeBox.GetNormalDir()CSPropProbeBox.GetOverSampling()CSPropProbeBox.GetProbeType()CSPropProbeBox.GetWeighting()CSPropProbeBox.SetFrequency()CSPropProbeBox.SetModeFile()CSPropProbeBox.SetModeFunction()CSPropProbeBox.SetModeOrigin()CSPropProbeBox.SetNormalDir()CSPropProbeBox.SetOverSampling()CSPropProbeBox.SetProbeType()CSPropProbeBox.SetWeighting()
- CSPropDumpBox
- CSPropDispersiveMaterial
- CSPropLorentzMaterial
- CSPropDebyeMaterial
- CSPropDiscMaterial
CSPropDiscMaterialCSPropDiscMaterial.GetDensityWeighted()CSPropDiscMaterial.GetEpsilonWeighted()CSPropDiscMaterial.GetFileType()CSPropDiscMaterial.GetFilename()CSPropDiscMaterial.GetKappaWeighted()CSPropDiscMaterial.GetMueWeighted()CSPropDiscMaterial.GetScale()CSPropDiscMaterial.GetSigmaWeighted()CSPropDiscMaterial.GetTransform()CSPropDiscMaterial.GetUseDataBaseForBackground()CSPropDiscMaterial.ReadFile()CSPropDiscMaterial.SetFileType()CSPropDiscMaterial.SetFilename()CSPropDiscMaterial.SetScale()CSPropDiscMaterial.SetTransform()CSPropDiscMaterial.SetUseDataBaseForBackground()
- CSPrimitives
- Notes
- Examples
- CSPrimitives (Base Class)
CSPrimitivesCSPrimitives.AddTransform()CSPrimitives.GetBoundBox()CSPrimitives.GetCoordinateSystem()CSPrimitives.GetDimension()CSPrimitives.GetID()CSPrimitives.GetParameterSet()CSPrimitives.GetPrimitiveUsed()CSPrimitives.GetPriority()CSPrimitives.GetProperty()CSPrimitives.GetTransform()CSPrimitives.GetType()CSPrimitives.GetTypeName()CSPrimitives.HasTransform()CSPrimitives.IsInside()CSPrimitives.SetCoordinateSystem()CSPrimitives.SetPrimitiveUsed()CSPrimitives.SetPriority()CSPrimitives.Update()CSPrimitives.fromType()
- CSPrimPoint
- CSPrimBox
- CSPrimMultiBox
- CSPrimCylinder
- CSPrimCylindricalShell
- CSPrimSphere
- CSPrimSphericalShell
- CSPrimPolygon
- CSPrimLinPoly
- CSPrimRotPoly
- CSPrimCurve
- CSPrimWire
- CSPrimPolyhedron
- CSPrimPolyhedronReader
- CSTransform
CSTransformCSTransform.AddTransform()CSTransform.GetMatrix()CSTransform.HasTransform()CSTransform.Reset()CSTransform.RotateAxis()CSTransform.RotateOrigin()CSTransform.Scale()CSTransform.SetMatrix()CSTransform.SetPostMultiply()CSTransform.SetPreMultiply()CSTransform.Transform()CSTransform.Translate()CSTransform.copy()
- CSRectGrid
CSRectGridCSRectGrid.AddLine()CSRectGrid.Clear()CSRectGrid.ClearLines()CSRectGrid.GetDeltaUnit()CSRectGrid.GetLine()CSRectGrid.GetLines()CSRectGrid.GetMeshType()CSRectGrid.GetQtyLines()CSRectGrid.GetSimArea()CSRectGrid.IsValid()CSRectGrid.SetDeltaUnit()CSRectGrid.SetLines()CSRectGrid.SetMeshType()CSRectGrid.SmoothMeshLines()CSRectGrid.Snap2LineNumber()CSRectGrid.Sort()
CoordinateSystem
- Mesh
- Utilities
- CSXCAD
- openEMS Python Interface
- openEMS
openEMSopenEMS.AddCPWPort()openEMS.AddCircWaveGuidePort()openEMS.AddCoaxialPort()openEMS.AddCurvePort()openEMS.AddEdges2Grid()openEMS.AddLumpedPort()openEMS.AddMSLPort()openEMS.AddRectWaveGuidePort()openEMS.AddStripLinePort()openEMS.AddWaveGuidePort()openEMS.CreateNF2FFBox()openEMS.GetCSX()openEMS.ReadFromXML()openEMS.Reset()openEMS.Run()openEMS.SetAbort()openEMS.SetBoundaryCond()openEMS.SetCSX()openEMS.SetCellConstantMaterial()openEMS.SetCoordSystem()openEMS.SetCustomExcite()openEMS.SetCylinderCoords()openEMS.SetDiracExcite()openEMS.SetEndCriteria()openEMS.SetGaussExcite()openEMS.SetMaxTime()openEMS.SetMultiGrid()openEMS.SetNumberOfTimeSteps()openEMS.SetOverSampling()openEMS.SetSinusExcite()openEMS.SetStepExcite()openEMS.SetTimeStep()openEMS.SetTimeStepFactor()openEMS.SetTimeStepMethod()openEMS.WelcomeScreen()openEMS.Write2XML()
- Ports
- NF2FF
- SAR
- Automatic Meshing
- Utilities
- HDF5 Field Dump Reader
HDF5DumpHDF5Dump.FREQ_RTOLHDF5Dump.fileHDF5Dump.Close()HDF5Dump.GetDumpTypeName()HDF5Dump.IsTD()HDF5Dump.IsFD()HDF5Dump.IsVector()HDF5Dump.GetNumTimesteps()HDF5Dump.GetNumFrequencies()HDF5Dump.GetTimes()HDF5Dump.ResetRegion()HDF5Dump.NearestIndex()HDF5Dump.SetPlane()HDF5Dump.SetLine()HDF5Dump.SetRange()HDF5Dump.SetSampling()HDF5Dump.GetMesh()HDF5Dump.GetFieldAtIndex()HDF5Dump.GetFieldAtFrequency()HDF5Dump.IterFD()HDF5Dump.IterTD()HDF5Dump.GetAttributes()
- Signal Processing
- HDF5 Field Dump Reader
- openEMS