dedalus.core.field

Class for data fields.

Module Contents

logger
permc_spec
use_umfpack
class Operand
static parse(string, namespace, domain)

Build operand from a string expression.

static cast(x, domain=None)
static raw_cast(x)
class Data

Bases:dedalus.core.field.Operand

set_scales(self, scales, keep_data=True)

Set new transform scales.

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

Return self.

canonical_linear_form(self, *vars)

Return self.

split(self, *vars)
replace(self, old, new)

Replace an object in the expression tree.

order(self, *ops)
operator_dict(self, index, vars, **kw)
sym_diff(self, var)

Symbolically differentiate with respect to var.

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

Bases:dedalus.core.field.Data

class ScalarMeta(scalar=None)

Shortcut class to return scalar metadata for any axis.

as_ncc_operator(self, **kw)

Return self.value.

class Array(domain, name=None)

Bases:dedalus.core.field.Data

from_global_vector(self, data, axis)
from_local_vector(self, data, axis)
as_ncc_operator(self, cacheid=None, **kw)

Cast to field and convert to NCC operator.

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

Bases:dedalus.core.field.Data

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
layout
create_buffer(self, scales)

Create buffer for Field data.

set_scales(self, scales, keep_data=True)

Set new transform scales.

require_layout(self, layout)

Change to specified layout.

towards_grid_space(self)

Change to next layout towards grid space.

towards_coeff_space(self)

Change to next layout towards coefficient space.

require_grid_space(self, axis=None)

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

require_coeff_space(self, axis=None)

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

require_local(self, axis)

Require an axis to be local.

differentiate(self, *args, **kw)

Differentiate field.

integrate(self, *args, **kw)

Integrate field.

interpolate(self, *args, **kw)

Interpolate field.

antidifferentiate(self, 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
static cast(input, domain)
as_ncc_operator(self, cutoff, max_terms, name=None, cacheid=None)

Convert to operator form representing multiplication as a NCC.