Output¶

Example usage

# Create an empty model
m = mstar.Load()

# Get the ModelOutput object
output = m.GetOutputConfig()

# Set a specific channel to be Enabled
output.PlanesOutput.EDR.Value = True

# Set the start/stop and interval
output.PlanesWrites.Start.Value = 1.0
output.PlanesWrites.Stop.Value = 2.0
output.PlanesWrites.Interval.Value = "0.1"

Note that the data structure itself is all readonly, as shown in the below document. Only the Values may be change to enable/disable an output.

class mstar.ModelOutput¶

Main entrypoint into options that change the output

property ParticleWritesEnabled: BoolProperty¶

property ParticleWrites: OutputWriteConfig¶: Readonly

property DataWrites: OutputWriteConfig¶: Readonly

property PlanesWrites: OutputWriteConfig¶: Readonly

property VolumesWrites: OutputWriteConfig¶: Readonly

property CheckPointWrites: OutputWriteConfig¶: Readonly

property PlanesOutput: StandardOutputs¶: Readonly

property VolumesOutput: StandardOutputs¶: Readonly

property ParticlesOutput: ParticleOutputs¶: Readonly

property BubblesOutput: ParticleOutputs¶: Readonly

property StaticBodiesOutput: StaticBodyOutputs¶: Readonly

class mstar.OutputWriteConfig¶

Configuration class to set start, stop, and intervals

property Start: DoubleProperty¶: Readonly

property Stop: DoubleProperty¶: Readonly

property Interval: ExpressionProperty¶: Readonly

property OutputCondition: ExpressionProperty¶: Readonly

class mstar.StaticBodyOutputs¶

property EnableOutputForces: BoolProperty¶: Readonly

property EnableOutputTimeAvgForces: BoolProperty¶: Readonly

property InstantHeatFlux: BoolProperty¶: Readonly

property TimeAvgHeatFlux: BoolProperty¶: Readonly

property EnableOutputTemp: BoolProperty¶: Readonly

property EnableOutputTempAvg: BoolProperty¶: Readonly

property ComputeWettedArea: BoolProperty¶: Readonly

property InstantScalarFlux: BoolProperty¶: Readonly

property TimeAvgScalarFlux: BoolProperty¶: Readonly

property EnableYPlus: BoolProperty¶: Readonly

class mstar.ParticleOutputs¶

property Velocity: BoolProperty¶: Readonly

property VelocityMag: BoolProperty¶: Readonly

property ID: BoolProperty¶: Readonly

property TimeAdded: BoolProperty¶: Readonly

property Diameter: BoolProperty¶: Readonly

property Origin: BoolProperty¶: Readonly

property TotalStrainRate: BoolProperty¶: Readonly

property EDR: BoolProperty¶: Readonly

property TimeAvgTurbKE: BoolProperty¶: Readonly

property TotalKE: BoolProperty¶: Readonly

property StrainRateTensor: BoolProperty¶: Readonly

property ExitStatistics: BoolProperty¶: Readonly

property Downselection: BoolProperty¶: Readonly

property ComputeResidenceTime: BoolProperty¶: Readonly

property Acceleration: BoolProperty¶: Readonly

property kLa: BoolProperty¶: Readonly

property TimeAvgBubbleFields: BoolProperty¶: Readonly

property SlipVelocity: BoolProperty¶: Readonly

property VolumeFraction: BoolProperty¶: Readonly

property SpecificSurfaceArea: BoolProperty¶: Readonly

property CellKLa: BoolProperty¶: Readonly

class mstar.StandardOutputs¶

property Velocity: BoolProperty¶: Readonly

property VelocityMag: BoolProperty¶: Readonly

property TotalKE: BoolProperty¶: Readonly

property TotalStrainRate: BoolProperty¶: Readonly

property EDR: BoolProperty¶: Readonly

property Vorticity: BoolProperty¶: Readonly

property VorticityMag: BoolProperty¶: Readonly

property Pressure: BoolProperty¶: Readonly

property StrainRateTensor: BoolProperty¶: Readonly

property ShearStress: BoolProperty¶: Readonly

property TimeAvgSpecies: BoolProperty¶: Readonly

property TimeAvgVelocity: BoolProperty¶: Readonly

property TimeAvgVelocityMag: BoolProperty¶: Readonly

property TimeAvgTurbKE: BoolProperty¶: Readonly

property TimeAvgTotalStrainRate: BoolProperty¶: Readonly

property TimeAvgEDR: BoolProperty¶: Readonly

property TimeAvgPressure: BoolProperty¶: Readonly

property TimeAvgShearStress: BoolProperty¶: Readonly

property Micromixing: BoolProperty¶: Readonly

property TurbulentViscosity: BoolProperty¶: Readonly