Inheritance diagram for phyex1d.physics_base.PhysicsBase:

Collaboration diagram for phyex1d.physics_base.PhysicsBase:

Public Member Functions
	__init__ (self, dt, method, name, tag, case, grid, prognostic_variables)

	setup (self, init_state, duration)

	finalize (self)

	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
	case

	grid

	prognostic_variables

	cst

Detailed Description

Base class for 1D model physics schemes

This class is not intended to be used directly.

Constructor & Destructor Documentation

◆ init()

phyex1d.physics_base.PhysicsBase.__init__	(	self,
		dt,
		method,
		name,
		tag,
		case,
		grid,
		prognostic_variables
	)

Reimplemented in phyex1d.phyex.PhysicsAromeTQ, phyex1d.phyex.PhysicsAromeThetaR, phyex1d.phyex.PhysicsForcingTQ, and phyex1d.phyex.PhysicsForcingThetaR.

Member Function Documentation

◆ add_conversions()

phyex1d.physics_base.PhysicsBase.add_conversions	(	self,
		state
	)

Add derived variables to the state

Parameters
----------
state : dict
    Current state

◆ add_vertical_coordinate()

phyex1d.physics_base.PhysicsBase.add_vertical_coordinate	(	self,
		state
	)

Add vertical coordinate to the state

Parameters
----------
state : dict
    Current state

◆ build_init_state()

phyex1d.physics_base.PhysicsBase.build_init_state	(	self,
		init_state
	)

Build the initial state

Parameters
----------
init_state : dict
    Initial state dictionary to populate

Returns
-------
dict
    Populated initial state

◆ execute()

phyex1d.physics_base.PhysicsBase.execute	(	self,
		previous_state,
		timestep,
		timestep_number
	)

Advance the state by one timestep

Parameters
----------
previous_state : dict
    Dictionary holding all the variables.
timestep : float
    Timestep (s)
timestep_number : int
    Current time step number

Returns
-------
dict
    State after time integration

◆ finalize()

phyex1d.physics_base.PhysicsBase.finalize ( self )

Tear down the scheme. Override in subclasses.

Reimplemented in phyex1d.phyex.PHYEX.

◆ forcing()

phyex1d.physics_base.PhysicsBase.forcing	(	self,
		state,
		timestep,
		timestep_number
	)

Apply large-scale forcings to the state

Parameters
----------
state : dict
    Dictionary holding all the variables.
timestep : float
    Timestep (s)
timestep_number : int
    Current time step number

Returns
-------
dict
    Updated state after forcing

◆ setup()

phyex1d.physics_base.PhysicsBase.setup	(	self,
		init_state,
		duration
	)

Set up the scheme. Override in subclasses.

Reimplemented in phyex1d.phyex.PHYEX.

◆ step()

phyex1d.physics_base.PhysicsBase.step	(	self,
		state,
		timestep,
		timestep_number
	)

Physics step. Override in subclasses.

Returns the state unchanged by default.

Reimplemented in phyex1d.phyex.PhysicsArome.

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

/home/runner/work/phyex1d/phyex1d/src/phyex1d/physics_base.py

Public Member Functions

Public Attributes