File: quick_reference_python.rst

package info (click to toggle)
dolfin 1.4.0%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 38,696 kB
  • ctags: 29,035
  • sloc: cpp: 409,305; python: 22,067; sh: 230; makefile: 215; xml: 126
file content (48 lines) | stat: -rw-r--r-- 1,914 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

.. title:: Quick Programmer's Reference (Python)

#####################################
Quick Programmer's Reference (Python)
#####################################

The complete :ref:`DOLFIN Programmer's Reference <genindex>` documents
**all** the classes and functions in DOLFIN. As a **quicker**
reference, here are some of the most commonly used classes and
functions, organized by topic:

.. tabularcolumns:: |c|c|c|c|

.. list-table::
    :widths: 20, 20, 20, 20
    :header-rows: 1
    :class: center

    * - Finite elements
      - Meshes
      - Variational problems
      - Linear systems

    * - :py:class:`FunctionSpace <dolfin.functions.functionspace.FunctionSpace>`
      - :py:class:`Mesh <dolfin.cpp.mesh.Mesh>`
      - :py:func:`solve <dolfin.fem.solving.solve>`
      - :py:func:`assemble <dolfin.fem.assembling.assemble>`

    * - :py:class:`TestFunction <dolfin.functions.function.TestFunction>`/:py:class:`TrialFunction <dolfin.functions.function.TrialFunction>`
      - :py:class:`MeshFunction <dolfin.cpp.mesh.MeshFunction>`
      - :py:class:`LinearVariationalProblem <dolfin.fem.solving.LinearVariationalProblem>`
      - :py:class:`Vector <dolfin.cpp.la.Vector>`

    * - :py:class:`Function <dolfin.functions.function.Function>`
      - :py:class:`SubDomain <dolfin.cpp.mesh.SubDomain>`
      - :py:class:`LinearVariationalSolver <dolfin.fem.solving.LinearVariationalSolver>`
      - :py:class:`Matrix <dolfin.cpp.la.Matrix>`

    * - :py:class:`Expression <dolfin.functions.expression.Expression>`
      -
      - :py:class:`NonlinearVariationalProblem <dolfin.fem.solving.NonlinearVariationalProblem>`
      - :py:class:`LUSolver <dolfin.cpp.la.LUSolver>`

    * - :py:class:`DirichletBC <dolfin.fem.bcs.DirichletBC>`
      -
      - :py:class:`NonlinearVariationalSolver <dolfin.fem.solving.NonlinearVariationalSolver>`
      - :py:class:`KrylovSolver <dolfin.cpp.la.KrylovSolver>`