API reference

The public API of PyTES. The models are PyBaMM models, so the methods they inherit from pybamm.BaseModel are documented by PyBaMM.

• Models
  • Finned tube
  • Packed bed
  • Base model and composition
• Submodels
  • AdvectedFluid
  • BaseSubModel
  • DeviceEnergy
  • EnthalpyStorage
  • FinRootCoupling
  • FinStorageCoupling
  • FlowPath
  • FluidState
  • Gnielinski
  • HeatTransferCoefficientOptions
  • Jeffreson
  • LumpedGeometry
  • LumpedStorage
  • NewtonCooling
  • NusseltCorrelation
  • PackedBedCorrelation
  • PerAreaTotals
  • StorageGeometry
  • SurfaceFluxLaw
  • TubeCorrelation
  • WakaoKaguei
  • WallCoupling
  • register_correlation()
• Experiments
  • Experiment
  • build_experiment_model()
  • run_experiment()
  • step_description()
  • Steps
• Parameters
  • Parameter layers
  • Device parameters
• Materials and fluids
  • Materials
  • Fluids
• Post-processing and plots
  • Post-processing
  • Plots
• Conformance and validation
  • Conformance checks
  • Analytical solutions
• Variables
  • REQUIRED_VARIABLES
  • OPTIONAL_VARIABLES
  • RESERVED_VARIABLES
  • FLOW_COORDINATE
  • FLOW_DOMAIN
  • UNIT_TWINS
  • is_temperature_difference()
  • unit_twins()
  • add_unit_twins()
• Renamed names
  • PyTESDeprecationWarning
  • Rename
  • RENAMES
  • find()
  • check()
  • module_getattr()
• PyBaMM workarounds
  • LimitedFiniteVolume
  • fluid_spatial_method()
  • resolve_coupled_variables()
  • set_step_description()
  • upwind_inlet_value()