framework

Module: fridom.framework

Submodules

exceptions	exceptions.py - Custom exceptions for the framework.
grid	All grid related classes and functions.
domain_decomposition	Domain Decomposition.
utils	Utility functions and classes for the FRIDOM framework.
time_steppers	Time Steppers.
modules	Base classes and functions for creating modules in the model.
projection	Projection.
timing_module	timing_module.py - Keep track of the time spent in different model components.

Classes, Functions, and Variables

config

Configuration class for the fridom framework.

log	Instances of the Logger class represent a single logging channel.

ModelSettingsBase(grid, **kwargs)

Base class for model settings container.

FieldBase(mset)

Base class for all types of fields.

FieldMetadata(name, long_name, units, ...)

Metadata for the ScalarField.

ScalarField(mset[, mdata, arr])

A scalar mapping from grid space to real / complex numbers.

VectorField(mset[, field_list, vector_dim])

A vector mapping from grid space to the vector space.

TensorField(mset)

ModelState(mset[, clock])

Stores the model state variables and the time information.

Model(mset)

The main model class.

Clock([start_date, start_time])	A clock to keep track of the model time.
TimingFormat(value[, names, module, ...])	The timing format for the model clock.

ClockTrigger([start_date, start_step, ...])

Emits signals based on the state of a clock.

Core modules of the FRIDOM framework.

Description

This module contain the base classes and functions for the FRIDOM framework. This module should mainly be used for developing new modules and models.