API Reference

• Creating and calling kernels from Python
  • Creating kernels
    • create_kernel()
    • CreateKernelConfig
    • create_domain_kernel()
    • create_indexed_kernel()
    • create_staggered_kernel()
  • Code printing
    • show_code()
  • GPU Indexing
    • AbstractIndexing
    • BlockIndexing
    • LineIndexing
• Enumerations
  • Target
    • Target.CPU
    • Target.GPU
  • Backend
    • Backend.C
    • Backend.CUDA
• Assignment Collection & Simplifications
  • AssignmentCollection
    • AssignmentCollection
  • SimplificationStrategy
    • SimplificationStrategy
  • Simplifications
    • sort_assignments_topologically()
    • sympy_cse()
    • sympy_cse_on_assignment_list()
    • subexpression_substitution_in_existing_subexpressions()
    • subexpression_substitution_in_main_assignments()
    • add_subexpressions_for_constants()
    • add_subexpressions_for_divisions()
    • add_subexpressions_for_sums()
    • add_subexpressions_for_field_reads()
    • transform_rhs()
    • apply_to_all_assignments()
    • apply_on_all_subexpressions()
  • Subexpression insertion
    • insert_subexpressions()
    • insert_aliases()
    • insert_zeros()
    • insert_constants()
    • insert_symbol_times_minus_one()
    • insert_constant_multiples()
    • insert_constant_additions()
    • insert_squares()
• DataHandling
  • DataHandling
    • DataHandling.default_target
    • DataHandling.dim
    • DataHandling.shape
    • DataHandling.periodicity
    • DataHandling.add_array()
    • DataHandling.add_arrays()
    • DataHandling.has_data()
    • DataHandling.add_array_like()
    • DataHandling.add_custom_data()
    • DataHandling.add_custom_class()
    • DataHandling.fields
    • DataHandling.array_names
    • DataHandling.custom_data_names
    • DataHandling.ghost_layers_of_field()
    • DataHandling.values_per_cell()
    • DataHandling.iterate()
    • DataHandling.gather_array()
    • DataHandling.run_kernel()
    • DataHandling.get_kernel_kwargs()
    • DataHandling.swap()
    • DataHandling.to_cpu()
    • DataHandling.to_gpu()
    • DataHandling.all_to_cpu()
    • DataHandling.all_to_gpu()
    • DataHandling.is_on_gpu()
    • DataHandling.create_vtk_writer()
    • DataHandling.create_vtk_writer_for_flag_array()
    • DataHandling.synchronization_function()
    • DataHandling.reduce_float_sequence()
    • DataHandling.reduce_int_sequence()
    • DataHandling.fill()
    • DataHandling.min()
    • DataHandling.max()
    • DataHandling.save_all()
    • DataHandling.load_all()
    • DataHandling.log()
    • DataHandling.log_on_root()
    • DataHandling.is_root
    • DataHandling.world_rank
• Configuration
  • Compiler Config (Linux)
  • Compiler Config (Windows)
• Field
  • Field
    • Field.create_generic()
    • Field.create_from_numpy_array()
    • Field.create_fixed_size()
    • Field.neighbor_vector()
    • Field.staggered_access()
    • Field.staggered_vector_access()
    • Field.Access
  • fields()
  • FieldType
• Stencil
  • inverse_direction()
  • inverse_direction_string()
  • is_valid()
  • is_symmetric()
  • have_same_entries()
  • coefficient_dict()
  • coefficients()
  • coefficient_list()
  • offset_component_to_direction_string()
  • offset_to_direction_string()
  • direction_string_to_offset()
  • adjacent_directions()
  • plot_2d()
  • plot_3d_slicing()
  • plot_3d()
  • plot_expression()
• Finite Differences
  • Diff
    • Diff.get_arg_recursive()
    • Diff.change_arg_recursive()
    • Diff.split_linear()
    • Diff.arg
    • Diff.target
    • Diff.superscript
    • Diff.interpolated_access()
  • diff()
  • DiffOperator
    • DiffOperator.apply()
  • diff_terms()
  • collect_diffs()
  • zero_diffs()
  • evaluate_diffs()
  • normalize_diff_order()
  • expand_diff_linear()
  • expand_diff_products()
  • combine_diff_products()
  • functional_derivative()
  • advection()
  • diffusion()
  • transient()
  • FVM1stOrder
    • FVM1stOrder.discrete_flux()
    • FVM1stOrder.discrete_source()
    • FVM1stOrder.discrete_continuity()
  • VOF()
• Plotting and Animation
  • vector_field()
  • vector_field_magnitude()
  • scalar_field()
  • scalar_field_surface()
  • scalar_field_alpha_value()
  • scalar_field_contour()
  • multiple_scalar_fields()
  • phase_plot()
  • sympy_function()
  • vector_field_animation()
  • vector_field_magnitude_animation()
  • scalar_field_animation()
  • surface_plot_animation()
• For developers: AST Nodes and Transformations
  • AST Nodes
    • Node
    • Conditional
    • KernelFunction
    • SkipIteration
    • Block
    • PragmaBlock
    • LoopOverCoordinate
    • SympyAssignment
    • ResolvedFieldAccess
    • TemporaryMemoryAllocation
    • TemporaryMemoryFree
    • SourceCodeComment
    • EmptyLine
    • ConditionalFieldAccess
  • Transformations
    • NestedScopes
    • iterate_loops_by_depth()
    • unify_shape_symbols()
    • get_common_field()
    • make_loop_over_domain()
    • create_intermediate_base_pointer()
    • parse_base_pointer_info()
    • get_base_buffer_index()
    • resolve_field_accesses()
    • move_constants_before_loop()
    • split_inner_loop()
    • cut_loop()
    • simplify_conditionals()
    • cleanup_blocks()
    • remove_conditionals_in_staggered_kernel()
    • get_optimal_loop_ordering()
    • get_loop_hierarchy()
    • get_loop_counter_symbol_hierarchy()
    • replace_inner_stride_with_one()
    • loop_blocking()