Skip to content

gmsh_opt

tit.tools.gmsh_opt

Generate Gmsh .opt visualization option files.

Creates a companion .opt file next to a .msh mesh so that Gmsh opens with sensible default view settings (visibility, colormap, range).

See Also

tit.blender.region_exporter : Uses create_mesh_opt_file when keep_meshes=True.

create_mesh_opt_file 

create_mesh_opt_file(mesh_path, field_info=None)

Create a .opt file for Gmsh visualization of mesh fields.

Parameters

mesh_path : str Path to the .msh file. The .opt extension is appended automatically. field_info : dict, optional Dictionary with field information. Recognised keys:

* ``'fields'`` -- list of field names to visualise.
* ``'max_values'`` -- dict mapping field names to their max values.
* ``'field_type'`` -- ``'node'`` or ``'element'`` (default ``'node'``).
Returns

str Path to the written .opt file.

Source code in tit/tools/gmsh_opt.py 
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def create_mesh_opt_file(mesh_path, field_info=None):
    """Create a ``.opt`` file for Gmsh visualization of mesh fields.

    Parameters
    ----------
    mesh_path : str
        Path to the ``.msh`` file.  The ``.opt`` extension is appended
        automatically.
    field_info : dict, optional
        Dictionary with field information.  Recognised keys:

        * ``'fields'`` -- list of field names to visualise.
        * ``'max_values'`` -- dict mapping field names to their max values.
        * ``'field_type'`` -- ``'node'`` or ``'element'`` (default ``'node'``).

    Returns
    -------
    str
        Path to the written ``.opt`` file.
    """
    if field_info is None:
        field_info = {}

    fields = field_info.get("fields", [])
    max_values = field_info.get("max_values", {})

    opt_content = """// Gmsh visualization settings for mesh fields
Mesh.SurfaceFaces = 0;
Mesh.SurfaceEdges = 0;
Mesh.Points = 0;
Mesh.Lines = 0;

"""

    for i, field_name in enumerate(fields):
        view_index = i + 1
        max_value = max_values.get(field_name, 1.0)
        opt_content += f"""// View[{view_index}] ({field_name})
View[{view_index}].Visible = 1;
View[{view_index}].ColormapNumber = {i + 1};
View[{view_index}].RangeType = 2;
View[{view_index}].CustomMin = 0;
View[{view_index}].CustomMax = {max_value};
View[{view_index}].ShowScale = 1;
View[{view_index}].ColormapAlpha = 1;
View[{view_index}].ColormapAlphaPower = 0.08;

"""

    opt_content += "// Field information:\n"
    for i, field_name in enumerate(fields):
        max_value = max_values.get(field_name, 1.0)
        opt_content += f"// View[{i + 1}]: {field_name} (max: {max_value:.6f})\n"

    opt_path = f"{mesh_path}.opt"
    with open(opt_path, "w") as f:
        f.write(opt_content)

    return opt_path