phyex1d
1D model using PHYEX
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | List of all members
phyex1d.phyex.PHYEX Class Reference
Inheritance diagram for phyex1d.phyex.PHYEX:
Inheritance graph
[legend]
Collaboration diagram for phyex1d.phyex.PHYEX:
Collaboration graph
[legend]

Public Member Functions

 __init__ (self, dt, method, name, tag, case, grid, prognostic_variables, pyphyex=None, pyecrad=None, namel=None, dx=0, dy=0, attrs=None)
 
 setup (self, init_state, duration)
 
 finalize (self)
 
- Public Member Functions inherited from phyex1d.physics_base.PhysicsBase
 execute (self, previous_state, timestep, timestep_number)
 
 step (self, state, timestep, timestep_number)
 
 add_vertical_coordinate (self, state)
 
 add_conversions (self, state)
 
 build_init_state (self, init_state)
 
 forcing (self, state, timestep, timestep_number)
 

Public Attributes

 pyphyex
 
 pyecrad
 
 namel
 
 full_phyex_namel
 
 dx
 
 dy
 
- Public Attributes inherited from phyex1d.physics_base.PhysicsBase
 case
 
 grid
 
 prognostic_variables
 
 cst
 

Protected Attributes

 _pyphyex
 
 _pyecrad
 
 _dt
 

Detailed Description

PHYEX-based physics scheme

This class handles the initialisation / setup of PHYEX and ECRAD.

Constructor & Destructor Documentation

◆ __init__()

phyex1d.phyex.PHYEX.__init__ (   self,
  dt,
  method,
  name,
  tag,
  case,
  grid,
  prognostic_variables,
  pyphyex = None,
  pyecrad = None,
  namel = None,
  dx = 0,
  dy = 0,
  attrs = None 
)

Member Function Documentation

◆ finalize()

phyex1d.phyex.PHYEX.finalize (   self)
Close PHYEX resources

Reimplemented from phyex1d.physics_base.PhysicsBase.

◆ setup()

phyex1d.phyex.PHYEX.setup (   self,
  init_state,
  duration 
)
Initialise PHYEX and ECRAD

Reimplemented from phyex1d.physics_base.PhysicsBase.


The documentation for this class was generated from the following file: