Skip to content

About

Publication-grade TikZ graphics for Ferrite.jl grids

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

18 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FerriteTikz.jl

Documentation CI codecov

Publication-grade TikZ graphics of Ferrite.jl grids. FerriteTikz emits plain TikZ code and hands it to TikzPictures.jl, so the figures use the fonts, line widths and colours of the document they end up in — and they stay vector graphics all the way into the PDF.

The focus is wireframes with flat, constant per-cell colouring, and the deformed configuration of a finite element solution. Grids in one or two spatial dimensions are supported: Triangle, Quadrilateral and their quadratic variants, plus Line and QuadraticLine elements for 1D meshes, trusses and frames. Quadratic cells are drawn with true curved edges.

For interactive exploration of a solution field, use FerriteViz.jl instead — the two packages are complementary.

Installation

julia> ]add FerriteTikz

Usage

using FerriteTikz

grid = generate_grid(Quadrilateral, (8, 4))
p = tikzgrid(grid; cellcolor = "blue!12", picturescale = 1.5)

save(PDF("grid"), p)                        # standalone PDF
save(SVG("grid"), p)                        # standalone SVG
save(TEX("grid"; limit_to = :picture), p)   # just the tikzpicture, ready to \input

The picture also renders inline in VSCode, Pluto and IJulia.

Colouring cells by cell set

addcellset!(grid, "steel",  x -> x[1] <= 0.0)
addcellset!(grid, "rubber", x -> x[1] >  0.0)

tikzgrid(grid; cellsetcolors = ["steel" => "gray!30", "rubber" => colorant"#e31a1c"])

Colours are either xcolor expressions given as Strings ("blue!20") or any Colors.Colorant, which is emitted as a \definecolor statement in the preamble.

The deformed configuration

p = tikzgrid(
    dh, u;                                  # DofHandler and global solution vector
    field = :u,                             # the displacement field
    scale = 20,                             # displacement magnification
    cellcolor = "blue!12",
    reference = (linecolor = "gray", linestyle = "dashed"),   # undeformed grid underneath
)

Instead of a DofHandler, nodal displacements can be passed directly, either as a Vector{Vec{2}} or as a flat Vector{<:Real} of length 2 * getnnodes(grid).

Line elements — 1D meshes, trusses and frames

Line and QuadraticLine cells work in both 1D and 2D space. A one-dimensional grid is drawn along the x axis:

tikzgrid(generate_grid(Line, (6,)); drawnodes = true, nodelabels = true)

A line element encloses no area, so it is stroked rather than filled and its cell colour becomes the stroke colour — which makes cellsetcolors the natural way to highlight members of a truss:

nodes = [Node((0.0, 0.0)), Node((1.0, 0.0)), Node((2.0, 0.0)), Node((0.5, 0.8)), Node((1.5, 0.8))]
truss = Grid([Line((1, 2)), Line((2, 3)), Line((1, 4)), Line((4, 2)),
              Line((2, 5)), Line((5, 3)), Line((4, 5))], nodes)
addcellset!(truss, "chord", [1, 2])

tikzgrid(truss; cellsetcolors = ["chord" => "red"], linewidth = "thick", drawnodes = true)

Unlike the shared edges of area cells, members are elements in their own right and are never deduplicated. Grids may mix area and line cells — a solid with reinforcement bars draws the quadrilaterals filled and the bars stroked on top.

On a 1D grid, Vec{2} displacements are also accepted, which draws a transverse deflection:

grid = generate_grid(Line, (20,))
w = [Vec{2}((0.0, 0.3 * sin(π * (x[1] + 1) / 2))) for x in Ferrite.get_node_coordinate.((grid,), 1:getnnodes(grid))]
tikzgrid(grid, w; reference = (linestyle = "dashed", linecolor = "gray"))

Element and mesh figures for papers

grid = generate_grid(QuadraticTriangle, (2, 2))
tikzgrid(
    grid;
    drawnodes = true, nodelabels = true, celllabels = true,
    linewidth = "thick", picturescale = 3,
)

Every styling option is documented in GridStyle.

Why TikZ and not a plotting package

tikzgrid produces TikZ path commands (\fill, \draw, \node) rather than a plot with axes, which is what a mesh figure actually needs: curved element edges become real cubic Bézier segments, shared element edges are stroked exactly once, and the whole picture is a handful of lines of LaTeX you can post-process by hand if the need arises. Use tikzcode(...) to get that code as a String.

License

MIT, see LICENSE.

Development

This package was mainly developed with AI assistance (Claude Code), however the code was already used in real live. Large parts of the code and the documentation were reviewed manually with a special emphasis on not relying on internal parts of Ferrite.jl.

About

Publication-grade TikZ graphics for Ferrite.jl grids

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages