dedalus.core.field

Class for data fields.

Module Contents

logger
class Operand
diff(*args, **kw)

Create Differentiation operator with this operand.

integ(*args, **kw)

Create Integration operator with this operand.

interp(*args, **kw)

Create Interpolation operator with this operand.

static parse(string, namespace, domain)

Build operand from a string expression.

static cast(x, domain=None)
static raw_cast(x)
class Data
set_scales(scales, keep_data=True)

Set new transform scales.

atoms(*types, **kw)
has(*atoms)
expand(*vars)

Return self.

canonical_linear_form(*vars)

Return self.

split(*vars)
replace(old, new)

Replace an object in the expression tree.

comp_order(ops, vars)
mul_order(vars)
operator_dict(index, vars, **kw)
sym_diff(var)

Symbolically differentiate with respect to var.

class Scalar(value=0, name=None, domain=None)
class ScalarMeta(scalar=None)

Shortcut class to return scalar metadata for any axis.

as_ncc_operator(frozen_arg_basis_meta, cutoff, max_terms, cacheid=None)

Return self.value.

class Array(domain, name=None)
property scales
from_global_vector(data, axis)
from_local_vector(data, axis)
as_ncc_operator(frozen_arg_basis_meta, cutoff, max_terms, cacheid=None)

Cast to field and convert to NCC operator.

class Field(domain, name=None, scales=None)

Scalar field over a domain.

Parameters
  • domain (domain object) – Problem domain

  • name (str, optional) – Field name (default: Python object id)

Variables
  • layout (layout object) – Current layout of field

  • data (ndarray) – View of internal buffer in current layout

property layout
property scales
create_buffer(scales)

Create buffer for Field data.

set_scales(scales, keep_data=True)

Set new transform scales.

require_layout(layout)

Change to specified layout.

towards_grid_space()

Change to next layout towards grid space.

towards_coeff_space()

Change to next layout towards coefficient space.

require_grid_space(axis=None)

Require one axis (default: all axes) to be in grid space.

require_coeff_space(axis=None)

Require one axis (default: all axes) to be in coefficient space.

require_local(axis)

Require an axis to be local.

differentiate(*args, **kw)

Differentiate field.

integrate(*args, **kw)

Integrate field.

interpolate(*args, **kw)

Interpolate field.

antidifferentiate(basis, bc, out=None)

Antidifferentiate field by setting up a simple linear BVP.

Parameters
  • basis (basis-like) – Basis to antidifferentiate along

  • bc ((str, object) tuple) – Boundary conditions as (functional, value) tuple. functional is a string, e.g. “left”, “right”, “int” value is a field or scalar

  • out (field, optional) – Output field

copy()
static cast(input, domain)
as_ncc_operator(frozen_arg_basis_meta, cutoff, max_terms, cacheid=None)

Convert to operator form representing multiplication as a NCC.