farray

Module

Description

$Id$

This module allocates and manages indices in the f-array in a controlled way. This includes handling different types of variable that may be stored in the f-array like PDE variables, auxiliaries, communicated auxiliaries and global variables.

The code follows the similar principles to the SharedVariables module but only handles integer indices.

Quick access

Types:

pp

Variables:

farray_acquire_scratch_area, farray_check_maux, farray_clean_up, farray_finalize_ode, farray_get_name, farray_index_append, farray_index_by_name, farray_index_by_name_ode, farray_index_reset, farray_register_auxiliary, farray_register_global, farray_register_ode, farray_register_pde, farray_register_variable, farray_release_scratch_area, farray_retrieve_metadata_ode, farray_size_by_name, farray_type_by_name, farray_use_auxiliary, farray_use_global, farray_use_pde, farray_use_variable, ifarray_err_duplicate, ifarray_err_indexmismatch, ifarray_err_nosuchcomponent, ifarray_err_nosuchvar, ifarray_err_outofspace, ifarray_err_wrongsize, ifarray_err_wrongtype, ifarray_type_auxiliary, ifarray_type_comm_auxiliary, ifarray_type_global, ifarray_type_nosuchtype, ifarray_type_pde, ifarray_type_scratch, scalar, tensor2, tensor2sym, tensor3, vector, vector2, vector4

Needed modules

• cparam (mvar(), maux(), mglobal(), maux_com(), mscratch(), lgpu()): $Id$

• cdata (nvar(), naux(), nscratch(), nglobal(), naux_com(), datadir(), lroot(), lwrite_aux(), lreloading(), n_odevars(), f_ode(), df_ode(), lode(), f_ode_diagnostics(), variable_substepped()): $Id$

• hdf5_io (index_reset(), index_append()): $Id$

• messages: $Id$

Types

• type  farraymanager/pp

  Type fields:

  • % farray_contents_list [real]

  • % p [integer,pointer]

Variables

• farraymanager/farray_acquire_scratch_area [public]

• farraymanager/farray_check_maux [public]

• farraymanager/farray_clean_up [public]

• farraymanager/farray_finalize_ode [public]

• farraymanager/farray_get_name [public]

• farraymanager/farray_index_append [public]

• farraymanager/farray_index_by_name [public]

• farraymanager/farray_index_by_name_ode [public]

• farraymanager/farray_index_reset [public]

• farraymanager/farray_register_auxiliary [public]

• farraymanager/farray_register_global [public]

• farraymanager/farray_register_ode [public]

• farraymanager/farray_register_pde [public]

• farraymanager/farray_register_variable [public]

• farraymanager/farray_release_scratch_area [public]

• farraymanager/farray_retrieve_metadata_ode [public]

• farraymanager/farray_size_by_name [public]

• farraymanager/farray_type_by_name [public]

• farraymanager/farray_use_auxiliary [public]

• farraymanager/farray_use_global [public]

• farraymanager/farray_use_pde [public]

• farraymanager/farray_use_variable [public]

• farraymanager/ifarray_err_duplicate [integer,parameter=5]

• farraymanager/ifarray_err_indexmismatch [integer,parameter=6]

• farraymanager/ifarray_err_nosuchcomponent [integer,parameter=2]

• farraymanager/ifarray_err_nosuchvar [integer,parameter=1]

• farraymanager/ifarray_err_outofspace [integer,parameter=7]

• farraymanager/ifarray_err_wrongsize [integer,parameter=4]

• farraymanager/ifarray_err_wrongtype [integer,parameter=3]

• farraymanager/ifarray_type_auxiliary [integer,parameter=3]

• farraymanager/ifarray_type_comm_auxiliary [integer,parameter=2]

• farraymanager/ifarray_type_global [integer,parameter=4]

• farraymanager/ifarray_type_nosuchtype [integer,parameter=0]

• farraymanager/ifarray_type_pde [integer,parameter=1]

• farraymanager/ifarray_type_scratch [integer,parameter=5]

• farraymanager/pp [private]

• farraymanager/scalar [integer,parameter=0]

• farraymanager/tensor2 [integer,parameter=9]

• farraymanager/tensor2sym [integer,parameter=6]

• farraymanager/tensor3 [integer,parameter=27]

• farraymanager/vector [integer,parameter=3]

• farraymanager/vector2 [integer,parameter=2]

• farraymanager/vector4 [integer,parameter=4]