sgio.read_output

sgio.read_output(filename: str, file_format: str, analysis: str = 'h', model_type: str = '', sg: StructureGene | None = None, **kwargs) → Model | StateCase | None

Read SG analysis output file.

Thin dispatcher that delegates to read_output_model() (for analysis='h') or read_output_state() (for analysis='d', 'l', 'fi'). Prefer those canonical APIs in new code; this entry point is kept for backward compatibility.

Parameters:

• filename (str) – Name of the SG analysis output file.

• file_format (str) – Format of the SG data file. Choose one from ‘vabs’, ‘sc’, ‘swiftcomp’.

• analysis (str, optional) –

  Indicator of SG analysis. Default is ‘h’. Choose one from

  • ’h’: Homogenization

  • ’d’ or ‘l’: Dehomogenization

  • ’fi’: Initial failure indices and strength ratios

• model_type (str) –

  Type of the macro structural model. Choose one from

  • ’SD1’: Cauchy continuum model

  • ’PL1’: Kirchhoff-Love plate/shell model

  • ’PL2’: Reissner-Mindlin plate/shell model

  • ’BM1’: Euler-Bernoulli beam model

  • ’BM2’: Timoshenko beam model

• sg (StructureGene, optional) – Structure gene object.

Returns:

• Model – If analysis is ‘h’, the constitutive model.

• StateCase – If analysis is ‘d’ or ‘l’, the (single) state case.

• object – If analysis is ‘fi’, the failure-index payload returned by the underlying solver-specific reader.

• None – If the file cannot be opened or the format is unsupported.