PyFlux Documentation (Beta version)

2022.2

Home
Flux PEEC PyFlux Documentation
All Flux PEEC functions and entities
FluxPEEC Functions
List of all FluxPEEC functions
switchBackgroundVisibility
Display background image

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

2022.2

PyFlux Documentation (Beta version)

Flux 2D PyFlux Documentation
All Flux 2D functions and entities
Flux 3D PyFlux Documentation
All Flux 3D functions and entities
Flux SKEW PyFlux Documentation
All Flux Skew functions and entities
Flux PEEC PyFlux Documentation
All Flux PEEC functions and entities
- FluxPEEC Entities
  List of all FluxPEEC entities
- FluxPEEC Functions
  List of all FluxPEEC functions
  - 320 more
  - 2DViewStandard1
    Set standard view 1
  - aboutFlux
    About Altair Flux...
  - AboutPEEC
    About InCa3D ...
  - AddVolumeElementsVisualizationBySelectionPlane
    Add to visualization by selection plane
  - adjust
    Adjust intersections
  - ArcadComputeArrowsOfConductorsCurrentDensity
    Compute arrows of current density on conductors
  - ArcadComputeArrowsOfConductorsInduction
    Compute arrows of magnetic flux density on conductors
  - ArcadComputeArrowsOfConductorsLaplaceForce
    Compute arrows of Laplace force per length unit on conductors
  - ArcadComputeArrowsOfConductorsLaplaceForceDensity
    Compute arrows of volumic Laplace force density on conductors
  - ArcadComputeConductorsLaplaceForce
    Compute Laplace force on conductors
  - ArcadComputeIsovaluesOfConductorsLaplaceForceDensity
    Compute isovalues of Laplace force density on conductors
  - ArcadComputeSpatialCurveOfLaplaceForceDensity
    Plot curves of Laplace force volumic density on a spatial curve
  - ArcadConductorsImport
    ARCAD conductors import
  - ArcadParametricSolving
    Parametric solving
  - ArcadPointsImport
    ARCAD points import
  - ArcadValuesExport
    Values export
  - 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)
  - AutomaticConnexion
    Automatic creation of connections
  - AutomaticImpedanceSensor
    Automatic creation of impedance probes
  - backgroundImage
    Modify the background image size
  - bevel
    Chamfer
  - build3DContourFaceRegion
    Build 3D contours on face regions
  - buildFaces
    Build faces
  - buildFacesSketcher
    Build faces
  - buildFacesWithOldAlgo
    Building of the faces with old algo
  - BuildProblem
    Build Problem
  - buildVolumes
    Build volumes
  - buildVolumesWithOldAlgo
    Building of the volumes with old algorithm
  - checkAllGeometry
    Check geometry
  - checkGeometry
    Check geometry
  - checkMesh
    Check mesh
  - checkPhysic
    Check physics
  - checkPhysicAQ
    Check physics
  - checkShellElementsFaceRegion
    Check shell Elements on face regions
  - 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
  - computeArrowsGrid2D
    Arrows on 2D grids
  - computeArrowsGrid3D
    Arrows on 3D grids
  - computeArrowsGrid3DBorder
    Arrows on border of 3D grids
  - ComputeArrowsOf2DgridCurrentDensity
    Compute arrows of current density on 2D grid
  - ComputeArrowsOf2DgridInduction
    Compute arrows of magnetic flux density on 2D grid
  - ComputeArrowsOf2DgridLaplaceForceDensity
    Compute arrows of Laplace force volumic density on 2D grid
  - ComputeArrowsOfConductorsCurrentDensity
    Compute arrows of current density on conductors
  - ComputeArrowsOfConductorsInduction
    Compute arrows of magnetic flux density on conductors
  - ComputeArrowsOfConductorsLaplaceForceDensity
    Compute arrows of Laplace force volumic density on conductors
  - computeBoundingBox
    Compute bounding box of problem
  - computeCapacitanceMatrix
    Compute capacitance matrix
  - ComputeConductorsLaplaceForce
    Compute Laplace forces in a list of conductors
  - ComputeConductorsLosses
    Compute losses in a list of conductors
  - ComputeCurrentDensityCoordPEEC
    Current density compution on a point (with coordinates)
  - ComputeInductionCoordPEEC
    Induction compution on a point (with coordinates)
  - computeIsolinesCutPlane
    Isolines on cut planes
  - computeIsolinesGrid2D
    Isolines on 2D grids
  - computeIsolinesGrid3D
    Isolines on 3D grids
  - ComputeIsolinesOf2DGridCurrentDensity
    Compute isolines of current density on 2D grid
  - ComputeIsolinesOf2DGridInduction
    Compute isolines of magnetic flux density on 2D grid
  - ComputeIsolinesOf2DGridLaplaceForceDensity
    Compute isolines of Laplace force volumic density on 2D grid
  - ComputeIsolinesOf2DGridLosses
    Compute isolines of losses density on 2D grid
  - ComputeIsolinesOfConductorsCurrentDensity
    Compute isolines of current density on conductors
  - ComputeIsolinesOfConductorsInduction
    Compute isolines of magnetic flux density on conductors
  - ComputeIsolinesOfConductorsLaplaceForceDensity
    Compute isolines of Laplace force volumic density on conductors
  - ComputeIsolinesOfConductorsLosses
    Compute isolines of losses density on conductors
  - computeIsovaluesCutPlane
    Isovalues on cut planes
  - computeIsovaluesGrid2D
    Isovalues on 2D grids
  - computeIsovaluesGrid3D
    Isovalues on 3D grids
  - ComputeIsovaluesOfConductorsCurrentDensity
    Compute isovalues of current density on conductors
  - ComputeIsovaluesOfConductorsInduction
    Compute isovalues of magnetic flux density on conductors
  - ComputeIsovaluesOfConductorsLaplaceForceDensity
    Compute isovalues of Laplace force volumic density on conductors
  - ComputeIsovaluesOfConductorsLosses
    Compute isovalues of losses density on conductors
  - ComputeOf2DGridCurrentDensity
    Compute isovalues of current density on 2D grid
  - ComputeOf2DGridInduction
    Compute isovalues of magnetic flux density on 2D grid
  - ComputeOf2DGridLaplaceForceDensity
    Compute isovalues of Laplace force volumic density on 2D grid
  - ComputeOf2DGridLosses
    Compute isovalues of losses density on 2D grid
  - ComputeSpatialCurveOfCurrentDensity
    Plot curves of current density on a spatial curve
  - ComputeSpatialCurveOfInduction
    Plot curves of magnetic flux density for spatial curve
  - ComputeSpatialCurveOfLaplaceForceDensity
    Plot curves of Laplace force volumic density on a spatial curve
  - ComputeSpatialCurveOfLossesDensity
    Plot curves of losses density for spatial curve
  - 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
  - convertPropagated
    Convert propagated entities
  - copy
    Copy
  - CopyCircuitElements
    Copy (Ctrl+C)
  - CreateConnectCaps
    Create and connect capacitors to conductors
  - CreateConnectCapsWithPinOption
    Create and connect capacitors to conductors
  - CreateMotor
    Create Motor
  - createTransientStartupFile
    Create file for transient startup
  - CurvesForImpendance
    Plot curves of self or mutual impedance
  - CurvesOfCurrentForComponent
    Plot curves of current in components
  - CurvesOfCurrentForUnidirectionnalConductor
    Plot curves of current in unidirectional conductors
  - CurvesOfLaplaceForceForConductors
    Plot curves of Laplace force on conductors
  - cut
    Cut
  - CutCircuitElements
    Cut (Ctrl+X)
  - defineCoordinatesSystem
    Define coordinates system
  - defineEchelle
    Define echelle
  - delete
    Delete
  - DeleteAllResults
    Delete all project results
  - deleteArrows
    Delete Arrows
  - deleteCapacitiveResults
    Delete capacitive results
  - DeleteCircuitElements
    Delete (Del)
  - DeleteCurrentApplication
    Delete current application
  - DeleteCurrentResults
    Delete all results of the project
  - deleteGeometry
    Delete
  - deleteImage
    Delete image
  - DeleteInductiveResults
    Delete scenario results
  - deleteIsolines
    Delete isolines
  - deleteIsovalues
    Delete isovalues
  - deleteMesh
    Delete meshing
  - deleteMeshCapacitive
    Delete capacitive meshing
  - DeleteMotor
    Delete Motor
  - DeleteProblem
    Delete Problem
  - deleteSelection
    Delete selection
  - DeleteWinding
    Delete Winding
  - disableExecution
    Switch in a writing mode without execution
  - DisconnectDeleteCaps
    Disconnect capacitors from conductors and delete
  - displayArrows
    Display or hide arrows
  - 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
  - evaluateGeometry
    Evaluate geometry
  - executeByteCode
    Run a compiled command file
  - exit
    Close the application
  - 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
  - exportDXF
    Export geometry to a DXF file
  - ExporterFastCap
    Export to FastCap
  - 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
  - exportToINPFile
    Export to FastHenry
  - exportToSOLCFile
    Export to SOLC file
  - exportToSOLFile
    Export to SOL file
  - exportToSOLIFile
    Export to SOLI file
  - extendLines
    Extend line
  - faq
    User portal - ALTAIR gate
  - fillHoleWithWireRatio
    Fill a hole with wire
  - fillHoleWithWireThickness
    Fill a hole with wire
  - fractionate
    Fractionate
  - generateFirstOrderElements
    Generate first order elements
  - generateGotItCouplingComponent
    Generate component for GOT-It coupling
  - generateHSTCouplingComponent
    Generate component for HyperStudy coupling (for HyperStudy 2019.1 and later)
  - generatePSCADCouplingComponent
    Generate component for PSCAD coupling
  - generateSecondOrderElements
    Generate second order elements
  - generateShellElements
    Generate Shell element
  - getActiveScenario
    Get Active Scenario( in post processing only)
  - 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
  - ImpedanceMatrixExport
    Impedance matrix
  - 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
  - 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
  - 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
  - ImportSpatialQuantity
    Import spatial quantity
  - ImportSpeedMotor
    Import Speed Motor
  - integralDomain
    Integral on the domain
  - integralFace
    Integral on face
  - integralLine
    Integral on line
  - interruptSpy
    Interrupt to write command in file
  - 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
  - LossesCurvesForConductors
    Plot curves of losses in conductors
  - 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
  - mergeFacesWithStartFace
    Merge faces with angle and a start face
  - mergeLines
    Merge two contiguous lines into one
  - mergeListOfFaces
    Merge a list of faces
  - MeshAllConductors
    Conductors mesh
  - MeshAllConductorsPostProcessing
    Conductors mesh for post processing
  - MeshCapacitive
    Mesh dielectrics and capacitive regions
  - meshDomain
    Mesh the domain
  - meshFaces
    Mesh the faces
  - meshLines
    Mesh lines
  - MeshReportFilePEEC
    Meshing report in file
  - MeshReportPEEC
    Meshing report
  - meshVolumes
    Mesh the volumes
  - meshVolumesOldAlgo
    Mesh volumes (old algo)
  - mesure
    Measure
  - modelerCutObject
    Object cut
  - ModelicaFilesExport
    RL macroblock for Modelica
  - monitor
    Monitor
  - NeutralFiberCreation
    Create Geometric Tubes or Tube Points from assimilation volumes
  - newProject
    New project
  - openAnimationViewerContext
    Open animation viewer
  - openBPMOverlay
    Brushless Permanent Magnet motor
  - OpenBPMOverlayImport
    Import SPEED motor
  - OpenBpmOverlayNew
    Create new Motor
  - openImage
    Open image
  - openImageImportContext
    Open the context for images-based creation
  - openIMDOverlay
    Induction motor
  - OpenIMDOverlayImport
    Import SPEED motor
  - OpenImdOverlayNew
    Create new Motor
  - openIODataContext
    Open data Import/Export context
  - openLibrary
    Ouvrir librairie ...
  - openModelerContext
    Modeler Context
  - openNDTOverlay
    NDT Sensor
  - openSketcher2dContext
    Sketcher 2D context
  - openSpy
    Choose the name of the new command file
  - optimMesh
    Optim mesh
  - paste
    Paste
  - PasteCircuitElements
    Paste (Ctrl+V)
  - PlotCurvesOfCurrentForTerminals
    Plot curves for current in terminals
  - PortunusFilesExport
    RL macroblock for Portunus
  - Presentations
    Presentations on Altair Flux - TV
  - printGraphicToFile
    Print the active view in a file
  - printGraphicToPrinter
    Print the active view
  - RaiseCriticalError
    RaiseCriticalError
  - RaiseCriticalErrorAndClose
    RaiseCriticalErrorAndClose
  - RaiseCriticalErrorAndExit
    RaiseCriticalErrorAndExit
  - RDM6Export
    RDM6 export
  - redo
    Redo
  - refreshViewStandard
    Refresh all views
  - removeFormule
    Evaluate parametrized formulas
  - 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
  - SaberFilesExport
    RL macroblock for Saber
  - saveProject
    Save current project
  - saveProjectAs
    Save current project as
  - scaling
    Scaling
  - searchFaceAbnormalEpsilon
    Search abnormal faces with user epsilon
  - searchLineFaceIntersection
    Search line-face intersections
  - searchLineLineIntersection
    Search line-line intersections
  - searchOpenWires
    Search open wires
  - searchPointsSuperimposed
    Search superimposed points
  - searchSmallLines
    Search abnormal lines with user epsilon
  - Select2DMeshFault
    Select mesh defaults
  - Select3DCondensateur
    Select capacitors
  - Select3DCurrentSource
    Select current sources
  - Select3DInductance
    Select inductors
  - Select3DResistor
    Select resistors
  - Select3DVoltageSource
    Select voltage sources
  - selectAll
    Select All
  - SelectCapacitiveRegion
    Select capacitive regions
  - SelectCircuitAll
    Free selection
  - SelectCircuitNone
    No selection
  - SelectCoil
    Select non meshed coils
  - SelectCompoundPath
    Select compound paths
  - SelectCondBi
    Select bidirectional conductors
  - SelectCondUni
    Select unidirectional conductors
  - SelectConnection
    Select connections
  - selectCurrentStep
    Select computation step
  - SelectDielectric
    Select dielectrics
  - 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
  - SelectImpedanceProbes
    Select impedance probes
  - SelectLine
    Select lines
  - SelectMagneticCut
    Select magnetic cut
  - SelectNone
    No selection
  - SelectObjet
    Select objects
  - SelectObjet2d
    Select 2D objects
  - SelectPath
    Select paths
  - SelectPoint
    Select points
  - selectReferencePlane
    Select reference planes
  - selectRefGeomObjectPlane
    Select cut planes
  - SelectRegLin
    Select line regions
  - SelectRegPonct
    Select point regions
  - SelectRegSurf
    Select face regions
  - SelectRegVol
    Select volume regions
  - SelectTerminal
    Select terminals
  - SelectTubeLine
    Select tube lines
  - SelectTubePoint
    Select tube points
  - 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
  - SetVisibleParasiticCapacitances
    Set visible parasitic capacitances between regions
  - showHideComponentsLabel
    Show or hide components label
  - showHidePotentialsLabel
    Show or hide potentials label
  - simplifyAllGeometry
    Simplify all lines
  - simplifyGeometry
    Automatically simplify geometry
  - simplifyLines
    Simplify lines
  - sketcherZoomAll
    Zoom all
  - skinDepth
    Skin depth computation
  - SolveFromBDPEEC
    Solve
  - SolveFromSOLPEEC
    Solve from SOL file
  - SolveNDT
    Solve NDT problem
  - SolvePEEC
    Solve
  - SolveWithDefect
    Solve with defect
  - SolveWithoutDefect
    Solve without defect
  - SolveWithoutRemeshingPEEC
    Solve without remeshing
  - SpatialCurveSuperimposition
    Superimpose 2D curves (path)
  - SPICEExportCapacitiveMacroblock
    SPICE file
  - SpiceFilesExport
    RL macroblock for SPICE
  - SpiceFilesRLCExport
    RLC macroblock for SPICE
  - structureFace
    Structure faces for mapped mesh (completion mode)
  - switchAxisVisibility
    Display axis
  - switchBackgroundVisibility
    Display background image
  - switchDefautVisibility
    Display geometric defects
  - switchFacesVisibility
    Display faces
  - switchGridVisibility
    Display grid
  - switchPointsVisibility
    Display points
  - switchReferencesVisibility
    Display reference lines and points
  - switchReperesVisibility
    Display coordinate systems
  - symetry
    Symmetry
  - translate
    Translation
  - unionfaces
    Merge faces
  - VariationCurveSuperimposition
    Superimpose 2D curves (I/O parameter)
  - vectorRepetition
    Linear repetition (vector)
  - verticalMirror
    Vertical mirror
  - VHDLAMSExportCapacitiveMacroblock
    VHDL-AMS file
  - VHDLAMSFilesExport
    RL macroblock for VHDL-AMS
  - VHDLAMSFilesRLCExport
    RLC macroblock for VHDL-AMS
  - 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

PyFlux Documentation (Beta version)

2022.2

Home
Flux PEEC PyFlux Documentation
All Flux PEEC functions and entities
FluxPEEC Functions
List of all FluxPEEC functions
switchBackgroundVisibility
Display background image

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

switchBackgroundVisibility

Display background image

Syntax

switchBackgroundVisibility()

Parameters

No parameter

Returns

No return value

© 2022 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent