PyFlux Documentation (Beta version)

Home
Flux 3D PyFlux Documentation
All Flux 3D functions and entities
Flux3D Functions
List of all Flux3D functions
CreateCircuitSquirrelCage
Create a new Squirrel cage

Flux 2D PyFlux Documentation
Flux 3D PyFlux Documentation
Flux SKEW PyFlux Documentation
Flux PEEC PyFlux Documentation

PyFlux Documentation (Beta version)

Flux 2D PyFlux Documentation
All Flux 2D functions and entities
Flux 3D PyFlux Documentation
All Flux 3D functions and entities
- Flux3D Entities
  List of all Flux3D entities
- Flux3D Functions
  List of all Flux3D functions
  - 48 more
  - 2DViewStandard1
    Set standard view 1
  - aboutFlux
    About Altair Flux...
  - AboutPEEC
    About InCa3D ...
  - activateNextStep
    Activate the next step
  - ActivateSecondApplication
    Activate second application
  - AddVolumeElementsVisualizationBySelectionPlane
    Add to visualization by selection plane
  - adjust
    Adjust intersections
  - advancedModeForElecCut
    Management of cuts in advanced mode
  - advancedModeForMagCut
    Management of cuts in advanced mode
  - assignCoilCondCompToNotMeshedCoils
    Assign coil conductor components to not meshed coils
  - assignGeomTerminalsToCoilCondRegCompletion
    Orient wires to coil conductor regions (completion mode)
  - assignMeshGeneratorToFace
    Assign mesh generator to faces (completion mode)
  - assignMeshGeneratorToVolumes
    Assign mesh generator to volumes (completion mode)
  - assignRegionToFaces
    Assign regions to faces (completion mode)
  - assignRegionToVolumes
    Assign regions to volumes (completion mode)
  - assignTerminalsToSolidCond2TerminalsCompletion
    Assign terminals to solid conductors 2 terminals (completion mode)
  - assignTerminalsToSolidCondNTerminalsCompletion
    Assign terminals to solid conductors (completion mode)
  - AuditScenarioProcedure
    Audit Scenario
  - AutomaticConnexion
    Automatic creation of connections
  - backgroundImage
    Modify the background image size
  - bertottiLossesRegion
    Bertotti iron losses
  - bevel
    Chamfer
  - build3DContourFaceRegion
    Build 3D contours on face regions
  - buildElectricLoopCut
    Automatic creation of cuts
  - buildFaces
    Build faces
  - buildFacesSketcher
    Build faces
  - buildFacesWithOldAlgo
    Building of the faces with old algo
  - buildFacesWithWire
    Build faces with wires
  - buildMagneticCircuitCut
    Automatic creation of cuts
  - BuildProblem
    Build Problem
  - buildVolumes
    Build volumes
  - buildVolumesWithOldAlgo
    Building of the volumes with old algorithm
  - buildvolumesWithWire
    Build volumes with wires
  - checkAllGeometry
    Check geometry
  - checkCircuit
    Check circuit
  - checkGeometry
    Check geometry
  - checkMesh
    Check mesh
  - checkPhysic
    Check physics
  - checkProject
    Check project before solving process
  - checkShellElementsFaceRegion
    Check shell Elements on face regions
  - checkSolver
    Check problem before solving process
  - circleRepetition
    Circular repetition
  - CircuitViewRefresh
    Refresh circuit view
  - CircuitViewZoomAll
    Zoom all
  - CircuitViewZoomInit
    Initial zoom
  - CircuitViewZoomRegion
    Zoom region
  - cleanAllMeshInformation
    Clean all mesh information
  - closeBoxes
    Close all opened dialog boxes
  - closeBPMOverlay
    Leave the "BPM Motor" overlay
  - closeImageImportContext
    Close image import context
  - closeIMDOverlay
    Leave the "IMD Motor" overlay
  - closeIODataContext
    Close the Input/Ouput data context (beta version)
  - closeLibrary
    Fermer librairie...
  - closeMechanicalAnalysisContext
    Close mechanical analysis context
  - closeModelerContext
    Leave the modeler context and return to standard geometry context
  - closeNDTOverlay
    Leave the "NDT Sensor" overlay
  - closePngViewerContext
    Close png viewer
  - closeProject
    Close the current project
  - closeSketcher2dContext
    Close Sketcher2DContext
  - closeSpy
    Close the spy file
  - collectData
    Collect data
  - compileSpy
    Compile a command file
  - computeArrowsCutPlane
    Arrows on cut planes
  - computeArrowsFace
    Arrows on faces
  - computeArrowsGrid2D
    Arrows on 2D grids
  - computeArrowsGrid3D
    Arrows on 3D grids
  - computeArrowsGrid3DBorder
    Arrows on border of 3D grids
  - computeArrowsRegionFace
    Arrows on face regions
  - computeArrowsRegionVolume
    Arrows in volume regions
  - computeArrowsRegionVolumeContour
    Arrows on contours (faces) of volume regions
  - computeBjAllRegions
    Compute the flux density created by current
  - computeBjLineRegions
    Compute the flux density created by current
  - computeBjSurfaceRegions
    Compute the flux density created by current
  - computeBjVolumeRegions
    Compute the flux density created by current
  - computeBoundingBox
    Compute bounding box of problem
  - computeCapacitanceMatrix
    Compute capacitance matrix
  - ComputeCurrentValueParameter
    Current values I/O parameter
  - computeElectricChargeFaceRegion
    Compute electric charge on a perfect conductor face region
  - computeElectricChargeLineRegion
    Compute electric charge on a perfect conductor line region
  - computeElectricChargePointRegion
    Compute electric charge on a point region
  - computeElectricChargeVolumeRegion
    Compute electric charge on a perfect conductor volume region
  - computeEnergyElecMagDomaine
    Compute electromagnetic energy on the domain
  - computeEnergyElecMagFaceRegion
    Compute electromagnetic energy on face regions
  - computeEnergyElecMagLineRegion
    Compute electromagnetic energy on line regions
  - computeEnergyElecMagVolumeRegion
    Compute electromagnetic energy on volume regions
  - computeEnergyElecStatDomaine
    Compute electrostatic energy on the domain
  - computeEnergyElecStatFaceRegion
    Compute electrostatic energy on face regions
  - computeEnergyElecStatLineRegion
    Compute electrostatic energy on line regions
  - computeEnergyElecStatVolumeRegion
    Compute electrostatic energy on volume regions
  - computeFluxCoilConductor
    Compute flux through a coil conductor
  - computeForceElecMagFaceRegion
    Compute electromagnetic force on face regions
  - computeForceElecMagLineRegion
    Compute electromagnetic force on line regions
  - computeForceElecMagVolumeRegion
    Compute electromagnetic force on volume regions
  - computeForceElecStatFaceRegion
    Compute electrostatic force on face regions
  - computeForceElecStatLineRegion
    Compute electrostatic force on line regions
  - computeForceElecStatVolumeRegion
    Compute electrostatic force on volume regions
  - ComputeForceLaplaceFaceRegion
    Compute the Laplace force on face regions
  - ComputeForceLaplaceLineRegion
    Compute the Laplace force on line regions
  - ComputeForceLaplaceVolumeRegion
    Compute the Laplace force on volume regions
  - computeIsolinesCutPlane
    Isolines on cut planes
  - computeIsolinesFace
    Isolines on faces
  - computeIsolinesGrid2D
    Isolines on 2D grids
  - computeIsolinesGrid3D
    Isolines on 3D grids
  - computeIsolinesRegionFace
    Isolines on face regions
  - computeIsolinesRegionVolume
    Isolines on volume regions
  - computeIsovaluesCutPlane
    Isovalues on cut planes
  - computeIsovaluesFace
    Isovalues on faces
  - computeIsovaluesGrid2D
    Isovalues on 2D grids
  - computeIsovaluesGrid3D
    Isovalues on 3D grids
  - computeIsovaluesRegionFace
    Isovalues on face regions
  - computeIsovaluesRegionVolume
    Isovalues on volume regions
  - computeIsovaluesVolume
    Compute isovalues on volumes
  - computeLossesDomaine
    Compute losses on the domain
  - computeLossesFaceRegion
    Compute lossses on face regions
  - computeLossesLineRegion
    Compute losses on line regions
  - computeLossesVolumeRegion
    Compute losses on volume regions
  - ComputePoint
    New session Quantities computation on points
  - computeTorqueElecMagFaceRegion
    Computation of electromagnetic torque on face regions
  - computeTorqueElecMagLineRegion
    Computation of electromagnetic torque on line regions
  - computeTorqueElecMagVolumeRegion
    Computation of electromagnetic torque on volume regions
  - computeTorqueElecStatFaceRegion
    Computation of electrostatic torque on face regions
  - computeTorqueElecStatLineRegion
    Computation of electrostatic torque on line regions
  - computeTorqueElecStatVolumeRegion
    Computation of electrostatic torque on volume regions
  - conge
    Fillet
  - ConnectedGroup
    Check groups of connected conductors
  - ContinueSolvingAuto
    Continue the solving process
  - ContinueSolvingEvol
    Continue the solving process with a variation parameter
  - ContinueSolvingIter
    Continue the solving process on the iteration
  - convertApplicationToMagneticAC
    to Steady State AC Magnetic
  - convertApplicationToMagneticACThermalTransient
    to Steady State AC Magnetic coupled with Transient Thermal 2D
  - convertApplicationToMagneticDC
    to Magneto Static
  - convertApplicationToMagneticTransient
    to Transient Magnetic
  - convertApplicationToThermalSteady
    to Steady State Thermal
  - convertApplicationToThermalTransient
    to Transient Thermal
  - convertPropagated
    Convert propagated entities
  - copy
    Copy
  - CopyCircuitElements
    Copy (Ctrl+C)
  - coverWire
    Cover wires defined by a list of lines
  - CreateCircuitBrushSegment
    Create a new Brush segment
  - CreateCircuitCapacitor
    Create a new Capacitor
  - CreateCircuitCoilConductor
    Create a new Coil conductor
  - CreateCircuitCurrentSource
    Create a new Current source
  - CreateCircuitDiode
    Create a new Diode
  - CreateCircuitGround
    Create a new Ground
  - CreateCircuitInductor
    Create a new Inductor
  - CreateCircuitNTerminalsSolidConductor
    Create a new Solid conductor n terminals
  - CreateCircuitResistor
    Create a new Resistor
  - CreateCircuitSolidConductor
    Create a new Solid conductor 2 terminals
  - CreateCircuitSquirrelCage
    Create a new Squirrel cage
  - CreateCircuitSwitch
    Create a new Switch
  - CreateCircuitVoltageSource
    Create a new Voltage source
  - CreateLSMaterial
    Create LS type material
  - CreateMotor
    Create Motor
  - createTabulatedParameterByImport
    New tabulated I/O parameter by importation of a 2D table
  - CreateTemperature
    New spatial quantity TKelvin for temperature
  - createTransientStartupFile
    Create file for transient startup
  - currentValues
    Current Values
  - curveRegionFace
    Face Region Curve
  - cut
    Cut
  - CutCircuitElements
    Cut (Ctrl+X)
  - defineCoordinatesSystem
    Define coordinates system
  - defineEchelle
    Define echelle
  - defineNextSteps
    Define next steps
  - delete
    Delete
  - DeleteAllResults
    Delete all project results
  - deleteArrows
    Delete Arrows
  - DeleteCircuitElements
    Delete (Del)
  - DeleteCurrentApplication
    Delete current application
  - DeleteCurrentResults
    Delete all results of the project
  - DeleteElectricCircuit
    Delete electrical circuit
  - deleteGeometry
    Delete
  - deleteImage
    Delete image
  - deleteIsolines
    Delete isolines
  - deleteIsovalues
    Delete isovalues
  - deleteMesh
    Delete meshing
  - DeleteMotor
    Delete Motor
  - DeleteProblem
    Delete Problem
  - deleteSelection
    Delete selection
  - DeleteSeveralSteps
    Delete the n last steps
  - DeleteWinding
    Delete Winding
  - disableExecution
    Switch in a writing mode without execution
  - displayArrows
    Display or hide arrows
  - displayArrowsOnMagnet
    Display arrows on magnet
  - displayFormattedFileOption
    Afficher etat fortran de la variable FLUX_FORMATTED_FILE
  - displayIsolines
    Display or hide isolines
  - displayIsovalues
    Display or hide isovalues
  - displayOrHideGrid
    Display or hide grid
  - displayOrHideImage
    Display or hide image
  - displayOrHidePoints
    Display or hide points
  - displayOrHideRepere
    Display or hide coordinate system
  - displayOrHideTable
    Display or hide table
  - drawArc2PointsAngle
    Arc 2 points without center
  - drawArc2PointsRadius
    Arc 2 points with center
  - drawArc3Points
    Arc 3 points
  - drawCircleDiameter
    Circle diameter
  - drawCircleRadius
    Circle center+radius
  - drawLine
    Polyline
  - drawPoints
    Draw points
  - drawRectangle
    Rectangle diagonal
  - drawRectangleCenter
    Rectangle Center
  - drawRefLine
    Reference line
  - drawRefPoint
    Reference point
  - EditCurrentApplication
    Edit current application
  - EditMotor
    Edit Motor
  - enableExecution
    Switch in normal mode with execution
  - errorCriterionRegion
    Error Criterion
  - errorCriterionyRegion
    Error Criterion
  - EvalDemagnetization
    Evaluation of the demagnetization
  - evaluateGeometry
    Evaluate geometry
  - evaluateSensors
    Evaluate sensors
  - executeByteCode
    Run a compiled command file
  - exit
    Close the application
  - export2DGeometryFromAcisFile
    2D Export to a SAT file
  - export2DGeometryFromCatiaV5File
    2D Export to a CATIA V5 file
  - export2DGeometryFromSTEPFile
    2D Export to a STEP file
  - exportCADFromAcisFile
    Export to a SAT file
  - exportCADFromCatiaV4File
    Export to a CATIA V4 file
  - exportCADFromCatiaV5File
    Export to a CATIA V5 file
  - exportCADFromIGESFile
    Export to an IGES file
  - exportCADFromSTEPFile
    Export to a STEP file
  - exportCircuit
    Export circuit to a xcir file
  - exportCircuitToPyFlux
    Export circuit to a PyFlux file
  - exportDXF
    Export geometry to a DXF file
  - exportGeometryFromAcisFile
    Export to a SAT file
  - exportGeometryFromCatiaV4File
    Export to a CATIA V4 file
  - exportGeometryFromCatiaV5File
    Export to a CATIA V5 file
  - exportGeometryFromIGESFile
    Export to an IGES file
  - exportGeometryFromSTEPFile
    Export to a STEP file
  - exportMeshToDEC
    Export mesh to a DEC file (Flux Expert)
  - exportMeshToMED
    Export mesh to a MED file (Available only in version Flux <= 12.3)
  - exportMeshToModulef
    Export mesh to a MODULEF file
  - exportMeshToPF3
    Export mesh to a PF3 file
  - exportMeshToTRA
    Export mesh to a TRA file (Flux2D)
  - exportMeshToUNV1
    Export mesh to an UNV file (IDEAS)
  - ExportNodeCoordRegions
    Export node coordinates of regions
  - ExportNodeCoordSpatialFormula
    Export node coordinates and spatial formula
  - ExportSpatialFormulaOnSupportMultipoint
    Export spatial formula on a multipoint support
  - extendLines
    Extend line
  - faq
    User portal - ALTAIR gate
  - fillHoleWithWireRatio
    Fill a hole with wire
  - fillHoleWithWireThickness
    Fill a hole with wire
  - finalizeCurrentStep
    Finalize the current step
  - fractionate
    Fractionate
  - generateActivateCouplingComponent
    Generate component for Activate coupling
  - generateAmesim3PhaseRotatingMotorComponent
    Generate Amesim component for 3 phase rotating motor
  - generateAmesimGenericComponent
    Generate generic AMESIm component
  - generateAmesimLinearActuatorComponent
    Generate Amesim component for linear actuator
  - generateFirstOrderElements
    Generate first order elements
  - generateGotItCouplingComponent
    Generate component for GOT-It coupling
  - generateHSTCouplingComponent
    Generate component for HyperStudy coupling (for HyperStudy 2019.1 and later)
  - generateMatlabSimulinkCouplingComponent
    Generate component for Matlab Simulink coupling
  - generatePortunusCouplingComponent
    Generate component for Portunus coupling
  - generatePSCADCouplingComponent
    Generate component for PSCAD coupling
  - generateSecondOrderElements
    Generate second order elements
  - generateShellElements
    Generate Shell element
  - getActiveScenario
    Get Active Scenario( in post processing only)
  - getLastTreatedStepStatus
    Get the status of the last processed step
  - getMeshElementsOnDomainFace
    Get mesh Elements on face domain
  - getMeshElementsOnDomainVolume
    Get mesh Elements on Domain
  - getMeshElementsOnRegionFace
    Get mesh Elements on face domain
  - getMeshElementsOnRegionVolume
    Get mesh Elements on Domain
  - getMeshNodesOnRegionFace
    Get nodes on face region
  - getMeshNodesOnRegionVolume
    Get nodes on volume region
  - healAllIntersections
    Heal all intersections
  - healAllSuperpositions
    Heal all superpositions
  - healAndSimplifyAllGeometry
    Heal and simplify all geometry
  - healGeometry
    Automatically heal geometry
  - healingCADGeometryContext
    Enter the "healing" context
  - healingCADToStandardGeometry
    Leave the "healing" context
  - healingFacetGeometryContext
    Enter the "facet geometry" context
  - healingFacetToStandardGeometry
    Leave the "facet geometry" context
  - healingImportCADContext
    Enter the "healing import CAD" context
  - healingImportCADToStandardGeometry
    Return to standard geometry context
  - helpContents
    Help (html documentation)
  - helpIndex
    Index...
  - hideBetaFeatures
    Hide Beta Features (standard mode)
  - horizontalMirror
    Horizontal mirror
  - imageImportRedo
    Redo
  - imageImportUndo
    Undo
  - importCADFromAcisFile
    Import of a SAT file
  - importCADFromCatiaV4File
    Import of a CATIA V4 file
  - importCADFromCatiaV5File
    Import of a CATIA V5 file
  - importCADFromIGESFile
    Import of an IGES file
  - importCADFromProEFile
    Import of a Pro/E file
  - importCADFromSTEPFile
    Import of a STEP file
  - importCircuit
    Import circuit from a xcir file
  - importCircuitFromCCS
    Import circuit from a CCS file
  - importCircuitFromCIF
    Import circuit from a CIF file
  - importCircuitFromTXT
    Import circuit from a TXT file
  - ImportFluxCurve2DFromASCIIFile
    Import a 2D curve - formatted file (txt)
  - ImportFluxCurve2DFromTxtFile
    Import a 2D curve - Flux file (txt)
  - ImportFluxCurve3DFromASCIIFile
    Import a 3D curve - formatted file (txt)
  - ImportFluxCurve3DFromTxtFile
    Import a 3D curve - Flux file (txt)
  - importGeomFromCATIAV4
    Import geometry from a CATIAV4 file
  - importGeomFromCATIAV5
    Import geometry from a CATIAV5 file
  - importGeomFromDXF
    Import geometry from a DXF file
  - importGeomFromDXFAdvanced
    Import geometry from a DXF file (advanced mode)
  - importGeomFromFBD
    Import geometry from a FBD file (FLUX2D)
  - importGeomFromIGES
    Import geometry from an IGES file
  - importGeomFromIGESAdvanced
    Import geometry from a IGES file (advanced mode)
  - importGeomFromInter
    Import geometry from an IF3 file (INTER)
  - importGeomFromInventor
    Import geometry from a Inventor file
  - importGeomFromNX
    Import geometry from a NX file
  - importGeomFromParasolid
    Import geometry from a PARASOLID file
  - importGeomFromProE
    Import geometry from a ProE file
  - importGeomFromSAT
    Import geometry from a SAT file
  - importGeomFromSolidWorks
    Import geometry from a SOLIDWORKS file
  - importGeomFromSTEP
    Import geometry from a STEP file
  - importGeomFromSTEPAdvanced
    Import geometry from a STEP file (advanced mode)
  - importGeomFromSTL
    Import geometry from a STL file
  - ImportGerberLayerPEEC
    Import of a Gerber layer
  - ImportGerberViaPEEC
    Import of Gerber vias
  - importMaterial
    Import material .DAT
  - importMatManager
    Import material from Material Manager
  - importMeshFromHMSLOSNastran
    Import mesh from a HyperMesh/SimLab/OptiStruct (Nastran) file
  - importMeshFromMED
    Import mesh from a MED file (Available only in version Flux <= 12.3)
  - importMeshFromNASTRAN
    Import mesh from a NASTRAN file
  - importMeshFromPATRAN
    Import mesh from a PATRAN file
  - importMeshFromUNV
    Import mesh from an UNV file (IDEAS)
  - importObjectFromFlux
    Import FLUX object
  - importObjectInSketcherFromFlux
    Import FLUX object
  - importPolarizationLaw
    Import polarization law (completion mode)
  - ImportSpatialQuantity
    Import spatial quantity
  - ImportSpeedMotor
    Import Speed Motor
  - initiateCurrentStep
    Initiate the current step
  - integralDomain
    Integral on the domain
  - integralFace
    Integral on face
  - integralLine
    Integral on line
  - integralVolume
    Integral on volume
  - interruptSpy
    Interrupt to write command in file
  - IronLossesPoint
    Iron losses at a point
  - IronLossesRegion
    Computation of iron losses
  - IronLossesRegionPostpro
    Iron losses on regions (postprocessing)
  - LabelLine
    Display line numbers
  - LabelPoint
    Display point numbers
  - LabelTubeLine
    Display tube lines numbers from graphic
  - LabelTubePoint
    Display tube points numbers from graphic
  - leaveOverlay
    Leave overlay
  - linearRepetition
    Linear repetition (matrix)
  - loadMacro
    Load a macro ...
  - loadOverlay
    Load a certified overlay
  - loadProject
    Open an existing project
  - loadUserOverlay
    Load a user overlay
  - lsLossesPoint
    LS iron losses at a point
  - lsLossesRegion
    LS iron losses on regions
  - magnetization
    Magnetization grid activation
  - makeBlendDefeaturing
    Make a blend defeaturing
  - makeChamferDefeaturing
    Make a chamfer defeaturing
  - makeDefeaturing
    Make a defeaturing
  - makeHoleDefeaturing
    Make a hole defeaturing
  - makeParametrizationUniformOnComplexLines
    Make parametrization uniform on complex lines
  - MaterialCurveSuperimposition
    Superimpose material curves
  - merge_lines
    Merge lines
  - mergeAllFacesWithAngle
    Merge all faces with angle
  - mergeAllLinesWithAngle
    Merge all the lines with angle
  - mergeFacesWithStartFace
    Merge faces with angle and a start face
  - mergeLines
    Merge two contiguous lines into one
  - mergeListOfFaces
    Merge a list of faces
  - mergeTwoLinesLists
    Merge two lists of lines
  - meshDomain
    Mesh the domain
  - meshFaces
    Mesh the faces
  - meshLines
    Mesh lines
  - MeshReportPEEC
    Meshing report
  - meshVolumes
    Mesh the volumes
  - meshVolumesOldAlgo
    Mesh volumes (old algo)
  - mesure
    Measure
  - modelerCutObject
    Object cut
  - monitor
    Monitor
  - newProject
    New project
  - openAnimationViewerContext
    Open animation viewer
  - openBPMOverlay
    Brushless Permanent Magnet motor
  - OpenBPMOverlayImport
    Import SPEED motor
  - OpenBpmOverlayNew
    Create new Motor
  - openCircuitDedicatedContext
    Enter the circuit dedicated context
  - openImage
    Open image
  - openIMDOverlay
    Induction motor
  - OpenIMDOverlayImport
    Import SPEED motor
  - OpenImdOverlayNew
    Create new Motor
  - openIODataContext
    Open data Import/Export context
  - openLibrary
    Ouvrir librairie ...
  - openMechanicalAnalysisContext
    Open mechanical analysis context
  - openModelerContext
    Modeler Context
  - openNDTOverlay
    NDT Sensor
  - openSessionMultiPhysicsWithNewScenario
    Multi physic solving session (new scenario)
  - openSketcher2dContext
    Sketcher 2D context
  - openSpy
    Choose the name of the new command file
  - optimMesh
    Optim mesh
  - orientRegSurfMaterial
    Orient material for face region
  - orientRegVolMaterial
    Orient material for volume region
  - paste
    Paste
  - PasteCircuitElements
    Paste (Ctrl+V)
  - powerBalance
    Power Balance
  - Presentations
    Presentations on Altair Flux - TV
  - printGraphicToFile
    Print the active view in a file
  - printGraphicToPrinter
    Print the active view
  - projectFacesOnCoeffPlane
    Project faces on a plane defined by coefficients
  - projectFacesOnCylinder
    Project the faces on a cylinder
  - projectFacesOnStandardPlaneWithAngle
    Project faces on a plane defined by a standard plane and a rotation angle
  - RaiseCriticalError
    RaiseCriticalError
  - RaiseCriticalErrorAndClose
    RaiseCriticalErrorAndClose
  - RaiseCriticalErrorAndExit
    RaiseCriticalErrorAndExit
  - redo
    Redo
  - refreshViewStandard
    Refresh all views
  - reinitCosimulation
    Deleting results and reinitializing the cosimulation
  - ReinitTemperature
    Reinitiliazing spatial quantity TKelvin for temperature
  - removeFormule
    Evaluate parametrized formulas
  - resetCurrentStep
    Reset the current step
  - resizeImage
    Resize image
  - resumeSpy
    Resume to write command in file
  - rotate
    Rotation
  - RotateCircuitElements
    Rotate (R)
  - rotationImage
    Rotate image
  - runPy
    Run a python file with complete GUI refresh
  - runPyInSilentMode
    Run a python file with reduced GUI refresh (faster)
  - runPyInSilentModeAndExit
    Execute a command file in batch mode and exit
  - saveProject
    Save current project
  - saveProjectAs
    Save current project as
  - scaling
    Scaling
  - searchFaceAbnormalEpsilon
    Search abnormal faces with user epsilon
  - searchFacesAbnormal
    Search abnormal faces
  - searchLineFaceIntersection
    Search line-face intersections
  - searchLineLineIntersection
    Search line-line intersections
  - searchLinesAbnormal
    Search abnormal lines
  - SearchLineSuperimposed
    Search superimposed lines
  - searchOpenWires
    Search open wires
  - searchPointsSuperimposed
    Search superimposed points
  - searchSmallLines
    Search abnormal lines with user epsilon
  - Select2DMeshFault
    Select mesh defaults
  - selectAll
    Select All
  - SelectBrushSegment
    Select brush segment components from circuit
  - SelectCapacitiveRegion
    Select capacitive regions
  - SelectCapacitor
    Select capacitor components from circuit
  - SelectCircuitAll
    Free selection
  - SelectCircuitNone
    No selection
  - SelectCoil
    Select non meshed coils
  - SelectCoilConductor
    Select coil conductor components from circuit
  - SelectCompoundPath
    Select compound paths
  - SelectCondBi
    Select bidirectional conductors
  - SelectCondUni
    Select unidirectional conductors
  - SelectConnection
    Select connections
  - SelectConnectionElec
    Select electric connections from circuit
  - SelectCurrentSource
    Select current source components from circuit
  - selectCurrentStep
    Select computation step
  - SelectCutPlane
    Select cut planes
  - SelectDielectric
    Select dielectrics
  - SelectDiode
    Select diode components from circuit
  - SelectElectricCut
    Select electric cut
  - SelectElectricTerminal
    Select electric terminals
  - SelectElementaryData
    Select données élémentaires
  - SelectFace
    Select faces
  - SelectGeomDefect
    Select geometric defects
  - SelectGeomObject
    Select geometric objects
  - SelectGeomObjectSubEntityFace
    Select face sub entities of geometric objects
  - SelectGeomObjectSubEntityLine
    Select edge sub entities of geometric objects
  - SelectGeomObjectSubEntityTop
    Select top sub entities of geometric objects
  - SelectGeomTube
    Select geometric tubes
  - SelectGrid2D
    Select 2D grids
  - SelectGrid3D
    Select 3D grids
  - SelectGround
    Select ground components from circuit
  - SelectInductor
    Select inductor components from circuit
  - SelectLine
    Select lines
  - SelectMagneticCut
    Select magnetic cut
  - SelectNone
    No selection
  - SelectObjet
    Select objects
  - SelectObjet2d
    Select 2D objects
  - SelectPath
    Select paths
  - SelectPoint
    Select points
  - SelectPotentialElec
    Select electric potentials from circuit
  - selectReferencePlane
    Select reference planes
  - selectRefGeomObjectPlane
    Select cut planes
  - SelectRegLin
    Select line regions
  - SelectRegPonct
    Select point regions
  - SelectRegSurf
    Select face regions
  - SelectRegVol
    Select volume regions
  - SelectResistor
    Select resistor components from circuit
  - SelectSegmentElec
    Select electric segments from circuit
  - SelectSolidConductor2Terminals
    Select 2 terminals solid conductor components from circuit
  - SelectSolidConductorNTerminals
    Select N terminals solid conductor components from circuit
  - SelectSquirrelCage
    Select squirrel cage components from circuit
  - SelectStreamers
    Select Streamers
  - SelectSwitch
    Select switch components from circuit
  - SelectTerminal
    Select terminals
  - SelectTubeLine
    Select tube lines
  - SelectTubePoint
    Select tube points
  - SelectVoltageSource
    Select voltage source components from circuit
  - SelectVolume
    Select volumes
  - SetDynamicRotation
    Allow to rotate around picked points or not (CTRL to invert it)
  - SetInvisibleParasiticCapacitances
    Set invisible all parasitic capacitances
  - SetNeutralApplication
    Set neutral application
  - showHideComponentsLabel
    Show or hide components label
  - showHidePotentialsLabel
    Show or hide potentials label
  - simplifyAllGeometry
    Simplify all lines
  - simplifyEllipses
    Automatically simplify ellipses
  - simplifyGeometry
    Automatically simplify geometry
  - simplifyLines
    Simplify lines
  - sketcherZoomAll
    Zoom all
  - skinDepth
    Skin depth computation
  - Solve
    Solve the problem
  - solveCosimulation
    Solving the cosimulation
  - solveCurrentStep
    Solve the current step
  - SolveFromBDPEEC
    Solve
  - SolveFromSOLPEEC
    Solve from SOL file
  - SolveNDT
    Solve NDT problem
  - SolvePEEC
    Solve
  - solveSeveralSteps
    Solve several steps
  - SolveWithDefect
    Solve with defect
  - SolveWithoutDefect
    Solve without defect
  - SolveWithoutRemeshingPEEC
    Solve without remeshing
  - SpatialCurveSuperimposition
    Superimpose 2D curves (path)
  - StopSolving
    Stop the solving process
  - structureFace
    Structure faces for mapped mesh (completion mode)
  - switchAxisVisibility
    Display axis
  - switchBackgroundVisibility
    Display background image
  - switchDefautVisibility
    Display geometric defects
  - switchGeometryLinesVisibility
    Display geometry lines
  - switchGeometryPointsVisibility
    Display geometry points
  - switchGridVisibility
    Display grid
  - switchPointsVisibility
    Display points
  - switchReferencesVisibility
    Display reference lines and points
  - switchReperesVisibility
    Display coordinate systems
  - symetry
    Symmetry
  - translate
    Translation
  - VariationCurveSuperimposition
    Superimpose 2D curves (I/O parameter)
  - vectorRepetition
    Linear repetition (vector)
  - verticalMirror
    Vertical mirror
  - ViewDirection
    Set the view direction
  - ViewFourSights
    Set/reset 4 views mode
  - ViewLight
    Switch on or off the light
  - ViewOpposite
    Set opposite view
  - ViewReverseVideo
    Reverse video
  - ViewStandard1
    Set standard view 1
  - ViewStandard2
    Set standard view 2
  - ViewXPlane
    Set X plane view
  - ViewYPlane
    Set Y plane view
  - ViewZPlane
    Set Z plane view
  - waitForFile
    Wait action on file
  - 287 more
Flux SKEW PyFlux Documentation
All Flux Skew functions and entities
Flux PEEC PyFlux Documentation
All Flux PEEC functions and entities

PyFlux Documentation (Beta version)

Home
Flux 3D PyFlux Documentation
All Flux 3D functions and entities
Flux3D Functions
List of all Flux3D functions
CreateCircuitSquirrelCage
Create a new Squirrel cage

Flux 2D PyFlux Documentation
Flux 3D PyFlux Documentation
Flux SKEW PyFlux Documentation
Flux PEEC PyFlux Documentation

CreateCircuitSquirrelCage

Create a new Squirrel cage

Syntax

CreateCircuitSquirrelCage()

Parameters

No parameter

Returns

No return value

Copyright (c) 1983-2021. Altair Engineering, Inc. All Rights Reserved. Contains trade secrets of Altair Engineering, Inc. Copyright notice does not imply publication.

Intellectual Property Rights Notice | Technical Support