Inheritance diagram for phyex1d.case.Case:
Public Member Functions | |
| contains (self, varname) | |
| get (self, varname, slice_idx=None) | |
| duration (self) | |
| description (self) | |
| get_interpolator (self, varname, grid) | |
| __enter__ (self) | |
| __exit__ (self, *args) | |
| close (self) | |
Detailed Description
Base class for case implementations All subclasses must provide: - description (str property) - duration (float property, seconds) - contains(varname) -> bool - get(varname, slice_idx=None) -> numpy.ndarray - get_interpolator(varname, grid) -> RegularGridInterpolator - context manager support (__enter__ / __exit__)
Member Function Documentation
◆ close()
| phyex1d.case.Case.close | ( | self | ) |
Close any open resources. Override in subclasses.
Reimplemented in phyex1d.case.CaseCommonFormat.
◆ contains()
| phyex1d.case.Case.contains | ( | self, | |
| varname | |||
| ) |
Check if a variable exists in the case data
Reimplemented in phyex1d.case.CaseCommonFormat, and phyex1d.case.CaseXarray.
◆ description()
| phyex1d.case.Case.description | ( | self | ) |
Case description string
Reimplemented in phyex1d.case.CaseCommonFormat, phyex1d.case.CaseXarray, and phyex1d.case.CaseXarray.
◆ duration()
| phyex1d.case.Case.duration | ( | self | ) |
Simulation duration in seconds
Reimplemented in phyex1d.case.CaseCommonFormat, and phyex1d.case.CaseXarray.
◆ get()
| phyex1d.case.Case.get | ( | self, | |
| varname, | |||
slice_idx = None |
|||
| ) |
Read a variable from the case data
Reimplemented in phyex1d.case.CaseCommonFormat, and phyex1d.case.CaseXarray.
◆ get_interpolator()
| phyex1d.case.Case.get_interpolator | ( | self, | |
| varname, | |||
| grid | |||
| ) |
Get or build an interpolator for a forcing variable
Reimplemented in phyex1d.case.CaseCommonFormat, and phyex1d.case.CaseXarray.
The documentation for this class was generated from the following file:
- /home/runner/work/phyex1d/phyex1d/src/phyex1d/case.py
