NAME

       fenicsformcompilerx - FEniCS Form Compiler X Documentation

       The   is   an   experimental   version   of   the   FEniCS   Form   Compiler.    It   is   developed   at
       https://github.com/FEniCS/ffcx.
                           ┌─────────────────────┬───────────────────────────────────────┐
                           │ ffcx                │ FEniCS Form Compiler (FFCx).          │
                           ├─────────────────────┼───────────────────────────────────────┤
                           │ ffcx.analysis       │ Compiler stage 1: Analysis.           │
                           ├─────────────────────┼───────────────────────────────────────┤
                           │ ffcx.naming         │                                       │
                           ├─────────────────────┼───────────────────────────────────────┤
                           │ ffcx.codegeneration │                                       │
                           ├─────────────────────┼───────────────────────────────────────┤
                           │ ffcx.compiler       │ Main  interface  for  compilation  of │
                           │                     │ forms.                                │
                           ├─────────────────────┼───────────────────────────────────────┤
                           │ ffcx.formatting     │ Compiler stage 5: Code formatting.    │
                           ├─────────────────────┼───────────────────────────────────────┤
                           │ ffcx.main           │ Command-line interface to FFCx.       │
                           ├─────────────────────┼───────────────────────────────────────┤
                           │ ffcx.__main__       │                                       │
                           ├─────────────────────┼───────────────────────────────────────┤
                           │ ffcx.parameters     │                                       │
                           └─────────────────────┴───────────────────────────────────────┘

FFCX

       FEniCS Form Compiler (FFCx).

       FFCx compiles finite element variational forms into C code.

FFCX.ANALYSIS

       Compiler stage 1: Analysis.

       This  module implements the analysis/preprocessing of variational forms, including automatic selection of
       elements, degrees and form representation type.

       Functions
                            ┌──────────────────────────────────┬────────────────────────┐
                            │ analyze_ufl_objects(ufl_objects, │ Analyze ufl object(s). │
                            │ parameters)                      │                        │
                            └──────────────────────────────────┴────────────────────────┘

       Classes
                                    ┌───────────────────────────────────────┬───┐
                                    │ ufl_data(form_data,  unique_elements, │   │
                                    │ ...)                                  │   │
                                    └───────────────────────────────────────┴───┘

FFCX.NAMING

       Functions
                       ───────────────────────────────────────────────────────────────────────
                         compute_signature(ufl_objects, tag)     Compute the signature hash.
                       ───────────────────────────────────────────────────────────────────────
                         dofmap_name(ufl_element, prefix)
                       ───────────────────────────────────────────────────────────────────────
                         expression_name(expression, prefix)
                       ───────────────────────────────────────────────────────────────────────
                         finite_element_name(ufl_element,
                         prefix)
                       ───────────────────────────────────────────────────────────────────────
                         form_name(original_form,     form_id,
                         prefix)
                       ───────────────────────────────────────────────────────────────────────
                         integral_name(original_form,
                         integral_type, ...)
                       ┌───────────────────────────────────────┬─────────────────────────────┐
                       │                                       │                             │
FFCX.CODEGENERATION    │                                       │                             │
       Functions       │                                       │                             │
                       │    ┌────────────────────┬─────────────┼─────────────────────────┐   │
--
FFCX.COMPILER          │                                       │                             │
--

FFCX.FORMATTING

       Compiler stage 5: Code formatting.

       This  module  implements the formatting of UFC code from a given dictionary of generated C++ code for the
       body of each UFC function.

       It relies on templates for UFC code available as part of the module ufc_utils.

       Functions
                     ┌───────────────────────────────────────┬──────────────────────────────────┐
                     │ format_code(code, parameters)         │ Format given code in UFC format. │
                     ├───────────────────────────────────────┼──────────────────────────────────┤
                     │ write_code(code_h,  code_c,   prefix, │                                  │
                     │ output_dir)                           │                                  │
                     └───────────────────────────────────────┴──────────────────────────────────┘

FFCX.MAIN

       Command-line interface to FFCx.

       Parse command-line arguments and generate code from input UFL form files.

       Functions
                                                 ┌──────────────┬───┐
                                                 │ main([args]) │   │
                                                 └──────────────┴───┘

FFCX.__MAIN__

FFCX.PARAMETERS

       Functions
                  ┌───────────────────────────────────────┬───────────────────────────────────────┐
                  │ get_parameters([priority_parameters]) │ Return   (a   copy   of)  the  merged │
                  │                                       │ parameter values for FFCX.            │
                  └───────────────────────────────────────┴───────────────────────────────────────┘

       • genindex

       • modindex

       • search

AUTHOR

       FEniCS Project

COPYRIGHT

       2021, FEniCS Project

0.3.0                                             Oct 21, 2021                            FENICSFORMCOMPILERX(1)