gemseo / third_party / pyxdsm

matrix_eqn module¶

class gemseo.third_party.pyxdsm.matrix_eqn.CellData(text, color, highlight)¶

Bases: tuple

Create new instance of CellData(text, color, highlight)

color¶: Alias for field number 1

highlight¶: Alias for field number 2

text¶: Alias for field number 0

class gemseo.third_party.pyxdsm.matrix_eqn.MatrixEquation[source]¶

Bases: object

add_variable(name, size=1, text='', color='blue')[source]¶

clear_terms()[source]¶

connect(src, target, text='', color=None, highlight=1)[source]¶

jacobian(transpose=False)[source]¶

operator(opperator='=')[source]¶

spacer()[source]¶

text(src, target, text)[source]¶: don’t connect the src and target, but put some text where a connection would be

vector(base_color='red', highlight=None)[source]¶

write(out_file=None, build=True, cleanup=True)[source]¶

Write output files for the matrix equation diagram. This produces the following:

{file_name}.tikz
A file containing the TIKZ definition of the tikz diagram.

{file_name}.tex
A standalone document wrapped around an include of the TIKZ file which can be compiled to a pdf.

{file_name}.pdf
An optional compiled version of the standalone tex file.

Parameters

file_name (str) – The prefix to be used for the output files
build (bool) – Flag that determines whether the standalone PDF of the XDSM will be compiled. Default is True.
cleanup (bool) – Flag that determines if padlatex build files will be deleted after build is complete

class gemseo.third_party.pyxdsm.matrix_eqn.TotalJacobian[source]¶