remap_profile

RemapProfile

This corresponds to the cs_profile routine in FV3

__call__(qs, a4_1, a4_2, a4_3, a4_4, delp, qmin=0.0)

Calculates the interpolation coefficients for a cubic-spline which models the distribution of the remapped field within each deformed grid cell.

Parameters:

Name	Type	Description	Default
qs	in	Bottom boundary condition	required
a4_1	out	The first interpolation coefficient	required
a4_2	out	The second interpolation coefficient	required
a4_3	out	The third interpolation coefficient	required
a4_4	out	The fourth interpolation coefficient	required
delp	in	The pressure difference between grid levels	required
qmin	in	The minimum value the field can take in a cell	0.0

__init__(stencil_factory, quantity_factory, kord, iv, dims)

The constraints on the spline are set by kord and iv.

Parameters:

Name	Type	Description	Default
stencil_factory	StencilFactory	creates stencils	required
quantity_factory	QuantityFactory	creates quantities	required
kord	int	???	required
iv	int	???	required
dims	Sequence[str]	dimensions on which to operate on inputs	required

apply_constraints(q, gam, a4_1, a4_2, a4_3, a4_4, ext5, ext6, extm)

Parameters:

Name	Type	Description	Default
q	inout		required
gam	out		required
a4_1	in		required
a4_2	out		required
a4_3	out		required
a4_4	out		required
ext5	out		required
ext6	out		required
extm	out		required

posdef_constraint_iv0(a4_1, a4_2, a4_3, a4_4)

Parameters:

Name	Type	Description	Default
a4_1	inout	First cubic interpolation coefficient	required
a4_2	inout	Second cubic interpolation coefficient	required
a4_3	inout	Third cubic interpolation coefficient	required
a4_4	inout	Fourth cubic interpolation coefficient	required

posdef_constraint_iv1(a4_1, a4_2, a4_3, a4_4)

Parameters:

Name	Type	Description	Default
a4_1	inout	First cubic interpolation coefficient	required
a4_2	inout	Second cubic interpolation coefficient	required
a4_3	inout	Third cubic interpolation coefficient	required
a4_4	inout	Fourth cubic interpolation coefficient	required

remap_constraint(a4_1, a4_2, a4_3, a4_4, extm)

Parameters:

Name	Type	Description	Default
a4_1	inout	First cubic interpolation coefficient	required
a4_2	inout	Second cubic interpolation coefficient	required
a4_3	inout	Third cubic interpolation coefficient	required
a4_4	inout	Fourth cubic interpolation coefficient	required
extm	in	If true sets a4_2 and a4_3 as a4_1 and a4_4 to 0	required

set_initial_vals(gam, q, delp, a4_1, a4_2, a4_3, a4_4, q_bot, qs)

Parameters:

Name	Type	Description	Default
gam	out		required
q	out		required
delp	in		required
a4_1	in		required
a4_2	out		required
a4_3	out		required
a4_4	out		required
q_bot	out		required
qs	in		required

set_interpolation_coefficients(gam, a4_1, a4_2, a4_3, a4_4, ext5, ext6, extm, qmin)

Parameters:

Name	Type	Description	Default
gam	in		required
a4_1	inout		required
a4_2	inout		required
a4_3	inout		required
a4_4	inout		required
ext5	in		required
ext6	in		required
extm	in		required
qmin	in		required