dolfin/plot ¶

Documentation for C++ code found in dolfin/plot/*.h

Contents

dolfin/plot
- Functions
  - interactive
  - plot
- Classes
  - ExpressionWrapper

Functions ¶

interactive ¶

C++ documentation for interactive from dolfin/plot/plot.h:

void dolfin::interactive(bool really = false)¶

Make the current plots interactive. If really is set, the interactive mode is entered even if ‘Q’ has been pressed.

Parameters:	really –

plot ¶

C++ documentation for plot from dolfin/plot/plot.h:

void dolfin::plot(const Expression &expression, const Mesh &mesh, const Parameters &parameters)¶

Plot expression (parameter version)

Parameters:	expression – mesh – parameters –

C++ documentation for plot from dolfin/plot/plot.h:

void dolfin::plot(const Expression &expression, const Mesh &mesh, std::string title = "", std::string mode = "auto")¶

Plot expression.

Parameters:	expression – mesh – title – mode –

C++ documentation for plot from dolfin/plot/plot.h:

void dolfin::plot(const MultiMesh &multimesh)¶

Plot multimesh.

Parameters:	multimesh –

C++ documentation for plot from dolfin/plot/plot.h:

void dolfin::plot(const Variable&, const Parameters &parameters)¶

Plot variable (parameter version)

Parameters:	var – parameters –

C++ documentation for plot from dolfin/plot/plot.h:

void dolfin::plot(const Variable&, std::string title = "", std::string mode = "auto")¶

Simple built-in plot commands for plotting functions and meshes. Plot variable of any supported type

Parameters:	var – title – mode –

C++ documentation for plot from dolfin/plot/plot.h:

std::shared_ptr<VTKPlotter> dolfin::plot(std::shared_ptr<const Expression> expression, std::shared_ptr<const Mesh> mesh, std::shared_ptr<const Parameters> parameters)¶

Plot expression (parameter, shared_ptr version)

Parameters:	expression – mesh – parameters –

C++ documentation for plot from dolfin/plot/plot.h:

std::shared_ptr<VTKPlotter> dolfin::plot(std::shared_ptr<const Expression> expression, std::shared_ptr<const Mesh> mesh, std::string title = "", std::string mode = "auto")¶

Plot expression (shared_ptr version)

Parameters:	expression – mesh – title – mode –

C++ documentation for plot from dolfin/plot/plot.h:

void dolfin::plot(std::shared_ptr<const MultiMesh> multimesh)¶

Plot multimesh (shared_ptr version)

Parameters:	multimesh –

C++ documentation for plot from dolfin/plot/plot.h:

std::shared_ptr<VTKPlotter> dolfin::plot(std::shared_ptr<const Variable>, std::shared_ptr<const Parameters> parameters)¶

Plot variable (parameter, shared_ptr version)

Parameters:	var – parameters –

C++ documentation for plot from dolfin/plot/plot.h:

std::shared_ptr<VTKPlotter> dolfin::plot(std::shared_ptr<const Variable>, std::string title = "", std::string mode = "auto")¶

Plot variable (shared_ptr version)

Parameters:	var – title – mode –

Classes ¶

ExpressionWrapper ¶

C++ documentation for ExpressionWrapper from dolfin/plot/ExpressionWrapper.h:

class dolfin::ExpressionWrapper¶

A light wrapper class to hold an expression to plot, along with the mesh to plot it on. Allows clean, templated plotter code in plot.cpp

dolfin::ExpressionWrapper::ExpressionWrapper(std::shared_ptr<const Expression> expression, std::shared_ptr<const Mesh> mesh)¶

Create wrapped expression object.

Parameters:	expression – mesh –

std::shared_ptr<const Expression> dolfin::ExpressionWrapper::expression() const¶: Get shared pointer to the expression.

std::shared_ptr<const Mesh> dolfin::ExpressionWrapper::mesh() const¶: Get shared pointer to the mesh.