Tutorial: Cubit+Abaqus

This tutorial implements the same workflow introduced in Tutorial 04: Simulation, but uses Cubit [57] for the geometry, partition, and meshing tasks. It is included as an example for how to use Cubit with a build system and include best practices, such as an API and CLI.

Note

Depending on your Cubit installation and operating system, it may not be possible to import Cubit into arbitrary Python 3 environments. Instead, it may be necessary to execute Cubit Python scripts using the Python interpreter bundled with Cubit. An alternate Cubit tutorial using waves.scons_extensions.add_cubit_python() is provided as tutorial_cubit_alternate

$ pwd
/home/roppenheimer/waves-tutorials
$ waves fetch --destination tutorial_cubit_alternate tutorials/tutorial_cubit_alternate

References

• Cubit: Python Interface [57]

• Cubit: Importing Cubit into Python [57]

• SCons Appendix D: AddPostAction [32]

• GNU sed and conda-forge sed [58]

Environment

SCons and WAVES can be installed in a Conda environment with the Conda package manager. See the Conda installation and Conda environment management documentation for more details about using Conda.

Note

The SALib and numpy versions may not need to be this strict for most tutorials. However, Tutorial: Sensitivity Study uncovered some undocumented SALib version sensitivity to numpy surrounding the numpy v2 rollout.

1. Create the tutorials environment if it doesn’t exist

   $ conda create --name waves-tutorial-env --channel conda-forge waves 'scons>=4.6' matplotlib pandas pyyaml xarray seaborn 'numpy>=2' 'salib>=1.5.1' pytest
   

2. Activate the environment

   $ conda activate waves-tutorial-env
   

Some tutorials require additional third-party software that is not available for the Conda package manager. This software must be installed separately and either made available to SConstruct by modifying your system’s PATH or by modifying the SConstruct search paths provided to the waves.scons_extensions.add_program() method.

Directory Structure

3. Create and change to a new project root directory to house the tutorial files if you have not already done so. For example

$ mkdir -p ~/waves-tutorials
$ cd ~/waves-tutorials
$ pwd
/home/roppenheimer/waves-tutorials

4. Create a new tutorial_cubit directory with the waves fetch command below

$ pwd
/home/roppenheimer/waves-tutorials
$ waves fetch --destination tutorial_cubit tutorials/tutorial_cubit
$ ls tutorial_cubit
modsim_package/  abaqus  cubit  SConstruct  sierra

5. Make the new tutorial_cubit directory the current working directory

$ pwd
/home/roppenheimer/waves-tutorials
$ cd tutorial_cubit
$ pwd
/home/roppenheimer/waves-tutorials/tutorial_cubit
$ ls
modsim_package/  abaqus  cubit  SConstruct  sierra

SConscript

Note that the tutorial_cubit directory has three SConscript files: cubit, abaqus, sierra. The first two are relevant to the current tutorial. The sierra workflow is described in the complementary Tutorial: Cubit+Sierra.

6. Review the cubit and abaqus tutorials and compare them against the Tutorial 04: Simulation files.

The structure has changed enough that a diff view is not as useful. Instead the contents of the new SConscript files are duplicated below.

waves-tutorials/tutorial_cubit/cubit

#! /usr/bin/env python
"""Rectangle compression workflow: geometry, partition, mesh

Requires the following ``SConscript(..., exports={})``

* ``env`` - The SCons construction environment with the following required keys

  * ``unconditional_build`` - Boolean flag to force building of conditionally ignored targets
  * ``cubit`` - String path for the Cubit executable

* ``element_type`` - The Cubit 4 node quadrilateral element type
* ``solver`` - The target solver to use when writing a mesh file
"""

import pathlib

import waves

# Inherit the parent construction environment
Import("env", "element_type", "solver")

# Simulation variables
build_directory = pathlib.Path(Dir(".").abspath)
workflow_name = build_directory.name

# Collect the target nodes to build a concise alias for all targets
workflow = []

# Rectangle 2D
# Geometry
workflow.extend(
    env.PythonScript(
        target=["rectangle_geometry.cub"],
        source=["#/modsim_package/cubit/rectangle_geometry.py"],
        subcommand_options="",
    )
)

# Partition
workflow.extend(
    env.PythonScript(
        target=["rectangle_partition.cub"],
        source=["#/modsim_package/cubit/rectangle_partition.py", "rectangle_geometry.cub"],
        subcommand_options="",
    )
)

# Mesh
if solver.lower() == "abaqus":
    mesh_extension = "inp"
elif solver.lower() in ["sierra", "adagio"]:
    mesh_extension = "g"
else:
    raise RuntimeError(f"Unknown solver '{solver}'")
workflow.extend(
    env.PythonScript(
        target=[f"rectangle_mesh.{mesh_extension}", "rectangle_mesh.cub"],
        source=["#/modsim_package/cubit/rectangle_mesh.py", "rectangle_partition.cub"],
        subcommand_options="--element-type ${element_type} --solver ${solver}",
        element_type=element_type,
        solver=solver,
    )
)


# Cube 3D
# Geometry
workflow.extend(
    env.PythonScript(
        target=["cube_geometry.cub"],
        source=["#/modsim_package/cubit/cube_geometry.py"],
        subcommand_options="",
    )
)

# Partition
workflow.extend(
    env.PythonScript(
        target=["cube_partition.cub"],
        source=["#/modsim_package/cubit/cube_partition.py", "cube_geometry.cub"],
        subcommand_options="",
    )
)

# Mesh
if solver.lower() == "abaqus":
    mesh_extension = "inp"
elif solver.lower() in ["sierra", "adagio"]:
    mesh_extension = "g"
else:
    raise RuntimeError(f"Unknown solver '{solver}'")
workflow.extend(
    env.PythonScript(
        target=[f"cube_mesh.{mesh_extension}", "cube_mesh.cub"],
        source=["#/modsim_package/cubit/cube_mesh.py", "cube_partition.cub"],
        subcommand_options="--element-type ${element_type} --solver ${solver}",
        element_type=element_type,
        solver=solver,
    )
)

# Collector alias based on parent directory name
env.Alias(f"{workflow_name}_cubit", workflow)

if not env["unconditional_build"] and not env["CUBIT_PROGRAM"]:
    print(f"Program 'cubit' was not found in construction environment. Ignoring '{workflow_name}' target(s)")
    Ignore([".", workflow_name], workflow)

waves-tutorials/tutorial_cubit/abaqus

#! /usr/bin/env python
"""Rectangle compression workflow: Abaqus solve

Requires the following ``SConscript(..., exports={})``

* ``env`` - The SCons construction environment with the following required keys

  * ``unconditional_build`` - Boolean flag to force building of conditionally ignored targets
  * ``abaqus`` - String path for the Abaqus executable
  * ``cubit`` - String path for the Cubit executable
"""

import pathlib

# Inherit the parent construction environment
Import("env")

# Simulation variables
build_directory = pathlib.Path(Dir(".").abspath)
workflow_name = build_directory.name

# Collect the target nodes to build a concise alias for all targets
workflow = []
datacheck = []

element_type = "QUAD"
solver = "abaqus"
SConscript("cubit", exports={"env": env, "element_type": element_type, "solver": solver}, duplicate=False)

# Modify mesh target(s) element type.
# Linux style sed command options must be modified for macOS. Command must be modified if on Windows.
env.AddPostAction("rectangle_mesh.inp", "sed -i 's/CPE4/CPS4/g' ${TARGET.abspath}")

# SolverPrep
copy_source_list = [
    "#/modsim_package/abaqus/rectangle_compression.inp",
    "#/modsim_package/abaqus/assembly.inp",
    "#/modsim_package/abaqus/boundary.inp",
    "#/modsim_package/abaqus/field_output.inp",
    "#/modsim_package/abaqus/materials.inp",
    "#/modsim_package/abaqus/parts.inp",
    "#/modsim_package/abaqus/history_output.inp",
]
workflow.extend(
    env.CopySubstfile(
        copy_source_list,
    )
)

# Abaqus Solve
solve_source_list = [
    "rectangle_compression.inp",
    "assembly.inp",
    "boundary.inp",
    "field_output.inp",
    "materials.inp",
    "parts.inp",
    "history_output.inp",
    "rectangle_mesh.inp",
]

datacheck.extend(
    env.AbaqusSolver(
        target=[
            "rectangle_compression_DATACHECK.odb",
            "rectangle_compression_DATACHECK.dat",
            "rectangle_compression_DATACHECK.msg",
            "rectangle_compression_DATACHECK.com",
            "rectangle_compression_DATACHECK.prt",
            "rectangle_compression_DATACHECK.023",
            "rectangle_compression_DATACHECK.mdl",
            "rectangle_compression_DATACHECK.sim",
            "rectangle_compression_DATACHECK.stt",
        ],
        source=solve_source_list,
        job="rectangle_compression_DATACHECK",
        program_options="-double both -datacheck",
    )
)

workflow.extend(
    env.AbaqusSolver(
        target=[
            "rectangle_compression.odb",
            "rectangle_compression.dat",
            "rectangle_compression.msg",
            "rectangle_compression.com",
            "rectangle_compression.prt",
            "rectangle_compression.sta",
        ],
        source=solve_source_list,
        job="rectangle_compression",
        program_options="-double both",
    )
)

# Collector alias based on parent directory name
env.Alias(workflow_name, workflow)
env.Alias(f"{workflow_name}_datacheck", datacheck)

if not env["unconditional_build"] and not env["ABAQUS_PROGRAM"]:
    print(f"Program 'abaqus' was not found in construction environment. Ignoring '{workflow_name}' target(s)")
    Ignore([".", workflow_name], workflow)
    Ignore([".", f"{workflow_name}_datacheck"], datacheck)

Note that Cubit does not support the Abaqus plane stress element CPS4, so we must add a post-action to the orphan mesh target to change the element type. A post-action is used to avoid generating intermediate target files, which would be required if we created a separate task for the file modification. This post-action is written to apply to a list, so if additional orphan mesh files needed the same modification, the post-action would be added to each targets’ build signature definition with a single AddPostAction definition.

The sed command is not available on all systems, but a Conda packaged version, conda-forge sed, of the GNU sed program can be used to provide system-to-system consistency with Conda environment management. See the Conda documentation for more information about virtual environment management with Conda.

Cubit Journal Files

7. Review the following journal files in the waves-tutorials/modsim_package/cubit directory.

The Cubit journal files include the same CLI introduced in Tutorial 02: Partition and Mesh for the Abaqus journal files. Besides the differences in Abaqus and Cubit commands, the major difference between the Abaqus and Cubit journal files is the opportunity to use Python 3 with Cubit, where Abaqus journal files must use the Abaqus controlled installation of Python 2. The API and CLI built from the Cubit journal files’ docstrings may be found in the WAVES-TUTORIAL API for cubit and the WAVES-TUTORIAL CLI for cubit, respectively.

waves-tutorials/tutorial_cubit/modsim_package/cubit/rectangle_geometry.py

import sys
import pathlib
import argparse

import cubit


def main(output_file, width, height):
    """Create a simple rectangle geometry.

    This script creates a simple Cubit model with a single rectangle part.

    :param str output_file: The output file for the Cubit model. Will be stripped of the extension and ``.cub`` will be
        used.
    :param float width: The rectangle width
    :param float height: The rectangle height

    :returns: writes ``output_file``.cub
    """
    output_file = pathlib.Path(output_file).with_suffix(".cub")

    cubit.init(["cubit", "-noecho", "-nojournal", "-nographics", "-batch"])
    cubit.cmd("new")
    cubit.cmd("reset")

    cubit.cmd(f"create vertex 0 0 0")
    cubit.cmd(f"create vertex {width} 0 0")
    cubit.cmd(f"create vertex {width} {height} 0")
    cubit.cmd(f"create vertex 0 {height} 0")
    cubit.cmd(f"create surface vertex 1,2,3,4")

    cubit.cmd(f"save as '{output_file}' overwrite")


def get_parser():
    script_name = pathlib.Path(__file__)
    # Set default parameter values
    default_output_file = script_name.with_suffix(".cub").name
    default_width = 1.0
    default_height = 1.0

    prog = f"python {script_name.name} "
    cli_description = "Create a simple rectangle geometry and write an ``output_file``.cub Cubit model file."
    parser = argparse.ArgumentParser(description=cli_description, prog=prog)
    parser.add_argument(
        "--output-file",
        type=str,
        default=default_output_file,
        # fmt: off
        help="The output file for the Cubit model. "
             "Will be stripped of the extension and ``.cub`` will be used, e.g. ``output_file``.cub "
             "(default: %(default)s",
        # fmt: on
    )
    parser.add_argument(
        "--width",
        type=float,
        default=default_width,
        help="The rectangle width",
    )
    parser.add_argument(
        "--height",
        type=float,
        default=default_height,
        help="The rectangle height",
    )
    return parser


if __name__ == "__main__":
    parser = get_parser()
    args = parser.parse_args()
    sys.exit(
        main(
            output_file=args.output_file,
            width=args.width,
            height=args.height,
        )
    )

waves-tutorials/tutorial_cubit/modsim_package/cubit/rectangle_partition.py

import sys
import shutil
import pathlib
import argparse

import cubit


def main(input_file, output_file, width, height):
    """Partition the simple rectangle geometry created by ``rectangle_geometry.py``

    This script partitions a simple Cubit model with a single rectangle part.

    **Feature labels:**

    * ``bottom_left`` - bottom left vertex
    * ``bottom_right`` - bottom right vertex
    * ``top_right`` - top right vertex
    * ``top_left`` - top left vertex
    * ``left`` - left edge nodes
    * ``top`` - top edge nodes
    * ``right`` - right edge nodes
    * ``bottom`` - bottom edge nodes
    * ``elset_left`` - left edge elements
    * ``elset_top`` - top edge elements
    * ``elset_right`` - right edge elements
    * ``elset_bottom`` - bottom edge elements

    :param str input_file: The Cubit model file created by ``rectangle_geometry.py``. Will be stripped of the extension
        and ``.cub`` will be used.
    :param str output_file: The output file for the Cubit model. Will be stripped of the extension and ``.cub`` will be
        used.
    :param float width: The rectangle width
    :param float height: The rectangle height

    :returns: writes ``output_file``.cub
    """
    input_file = pathlib.Path(input_file).with_suffix(".cub")
    output_file = pathlib.Path(output_file).with_suffix(".cub")

    # Avoid modifying the contents or timestamp on the input file.
    # Required to get conditional re-builds with a build system such as GNU Make, CMake, or SCons
    if input_file != output_file:
        shutil.copyfile(input_file, output_file)

    cubit.init(["cubit", "-noecho", "-nojournal", "-nographics", "-batch"])
    cubit.cmd("new")
    cubit.cmd("reset")

    cubit.cmd(f"open '{output_file}'")

    cubit.cmd("nodeset 1 add vertex 1")
    cubit.cmd("nodeset 1 name 'bottom_left'")
    cubit.cmd("nodeset 2 add vertex 2")
    cubit.cmd("nodeset 2 name 'bottom_right'")
    cubit.cmd("nodeset 3 add vertex 3")
    cubit.cmd("nodeset 3 name 'top_right'")
    cubit.cmd("nodeset 4 add vertex 4")
    cubit.cmd("nodeset 4 name 'top_left'")

    cubit.cmd("nodeset 5 add curve 4")
    cubit.cmd("nodeset 5 name 'left'")
    cubit.cmd("nodeset 6 add curve 3")
    cubit.cmd("nodeset 6 name 'top'")
    cubit.cmd("nodeset 7 add curve 2")
    cubit.cmd("nodeset 7 name 'right'")
    cubit.cmd("nodeset 8 add curve 1")
    cubit.cmd("nodeset 8 name 'bottom'")

    cubit.cmd("sideset 1 add curve 4")
    cubit.cmd("sideset 1 name 'elset_left'")
    cubit.cmd("sideset 2 add curve 3")
    cubit.cmd("sideset 2 name 'elset_top'")
    cubit.cmd("sideset 3 add curve 2")
    cubit.cmd("sideset 3 name 'elset_right'")
    cubit.cmd("sideset 4 add curve 1")
    cubit.cmd("sideset 4 name 'elset_bottom'")

    cubit.cmd(f"save as '{output_file}' overwrite")


def get_parser():
    script_name = pathlib.Path(__file__)
    # Set default parameter values
    default_input_file = script_name.with_suffix(".cub").name.replace("_partition", "_geometry")
    default_output_file = script_name.with_suffix(".cub").name
    default_width = 1.0
    default_height = 1.0

    prog = f"python {script_name.name} "
    cli_description = (
        "Partition the simple rectangle geometry created by ``rectangle_geometry.py`` "
        "and write an ``output_file``.cub Cubit model file."
    )
    parser = argparse.ArgumentParser(description=cli_description, prog=prog)
    parser.add_argument(
        "--input-file",
        type=str,
        default=default_input_file,
        # fmt: off
        help="The Cubit model file created by ``rectangle_geometry.py``. "
             "Will be stripped of the extension and ``.cub`` will be used, e.g. ``input_file``.cub "
             "(default: %(default)s",
        # fmt: on
    )
    parser.add_argument(
        "--output-file",
        type=str,
        default=default_output_file,
        # fmt: off
        help="The output file for the Cubit model. "
             "Will be stripped of the extension and ``.cub`` will be used, e.g. ``output_file``.cub "
             "(default: %(default)s",
        # fmt: on
    )
    parser.add_argument(
        "--width",
        type=float,
        default=default_width,
        help="The rectangle width",
    )
    parser.add_argument(
        "--height",
        type=float,
        default=default_height,
        help="The rectangle height",
    )
    return parser


if __name__ == "__main__":
    parser = get_parser()
    args = parser.parse_args()
    sys.exit(
        main(
            input_file=args.input_file,
            output_file=args.output_file,
            width=args.width,
            height=args.height,
        )
    )

waves-tutorials/tutorial_cubit/modsim_package/cubit/rectangle_mesh.py

import sys
import shutil
import pathlib
import argparse

import cubit


def main(input_file, output_file, global_seed, element_type="QUAD", solver="abaqus"):
    """Mesh the simple rectangle geometry partitioned by ``rectangle_partition.py``

    This script meshes a simple Cubit model with a single rectangle part.

    **Feature labels:**

    * ``NODES`` - all part nodes
    * ``ELEMENTS`` - all part elements

    :param str input_file: The Cubit model file created by ``rectangle_partition.py``. Will be stripped of the extension
        and ``.cub`` will be used.
    :param str output_file: The output file for the Cubit model. Will be stripped of the extension and ``.cub`` and
        ``.inp`` will be used for the model and orphan mesh output files, respectively.
    :param float global_seed: The global mesh seed size
    :param str element_type: The model element type. Must be a supported Cubit 4 node element type.
    :param str solver: The solver type to use when exporting the mesh

    :returns: writes ``output_file``.cub and ``output_file``.inp

    :raises RuntimeError: If the solver is not supported
    """
    input_file = pathlib.Path(input_file).with_suffix(".cub")
    output_file = pathlib.Path(output_file).with_suffix(".cub")
    abaqus_mesh_file = output_file.with_suffix(".inp")
    sierra_mesh_file = output_file.with_suffix(".g")

    # Avoid modifying the contents or timestamp on the input file.
    # Required to get conditional re-builds with a build system such as GNU Make, CMake, or SCons
    if input_file != output_file:
        shutil.copyfile(input_file, output_file)

    cubit.init(["cubit", "-noecho", "-nojournal", "-nographics", "-batch"])
    cubit.cmd("new")
    cubit.cmd("reset")

    cubit.cmd(f"open '{output_file}'")

    cubit.cmd(f"surface 1 size {global_seed}")
    cubit.cmd("mesh surface 1")
    cubit.cmd("set duplicate block elements off")

    cubit.cmd("nodeset 9 add surface 1")
    cubit.cmd("nodeset 9 name 'NODES'")

    cubit.cmd("block 1 add surface 1")
    cubit.cmd(f"block 1 name 'ELEMENTS' Element type {element_type}")

    cubit.cmd(f"save as '{output_file}' overwrite")

    if solver.lower() == "abaqus":
        # Export Abaqus orphan mesh for Abaqus workflow
        cubit.cmd(f"export abaqus '{abaqus_mesh_file}' partial dimension 2 block 1 overwrite everything")
    elif solver.lower() in ["sierra", "adagio"]:
        # Export Genesis file for Sierra workflow
        cubit.cmd(f"export mesh '{sierra_mesh_file}' overwrite")
    else:
        raise RuntimeError(f"Uknown solver '{solver}'")


def get_parser():
    script_name = pathlib.Path(__file__)
    # Set default parameter values
    default_input_file = script_name.with_suffix(".cub").name.replace("_mesh", "_partition")
    default_output_file = script_name.with_suffix(".cub").name
    default_global_seed = 1.0
    default_element_type = "QUAD"
    default_solver = "abaqus"

    prog = f"python {script_name.name} "
    cli_description = (
        "Mesh the simple rectangle geometry partitioned by ``rectangle_partition.py`` "
        "and write an ``output_file``.cub Cubit model file and ``output_file``.inp orphan mesh file."
    )
    parser = argparse.ArgumentParser(description=cli_description, prog=prog)
    parser.add_argument(
        "--input-file",
        type=str,
        default=default_input_file,
        # fmt: off
        help="The Cubit model file created by ``rectangle_partition.py``. "
             "Will be stripped of the extension and ``.cub`` will be used, e.g. ``input_file``.cub "
             "(default: %(default)s",
        # fmt: on
    )
    parser.add_argument(
        "--output-file",
        type=str,
        default=default_output_file,
        # fmt: off
        help="The output file for the Cubit model. "
             "Will be stripped of the extension and ``.cub`` will be used, e.g. ``output_file``.cub",
        # fmt: on
    )
    parser.add_argument(
        "--global-seed",
        type=float,
        default=default_global_seed,
        help="The global mesh seed size (default: %(default)s)",
    )
    parser.add_argument(
        "--element-type",
        type=str,
        default=default_element_type,
        help="The model element type. Must be a supported Cubit 4 node element type. " "(default: %(default)s)",
    )
    parser.add_argument(
        "--solver",
        type=str,
        default=default_solver,
        choices=["abaqus", "sierra", "adagio"],
        help="The target solver for the mesh file. (default: %(default)s)",
    )

    return parser


if __name__ == "__main__":
    parser = get_parser()
    args = parser.parse_args()
    sys.exit(
        main(
            input_file=args.input_file,
            output_file=args.output_file,
            global_seed=args.global_seed,
            element_type=args.element_type,
            solver=args.solver,
        )
    )

SConstruct

A diff against the SConstruct file from Tutorial 04: Simulation is included below to help identify the changes made in this tutorial.

waves-tutorials/tutorial_cubit/SConstruct

--- /home/runner/work/waves/waves/build/docs/tutorials_tutorial_04_simulation_SConstruct
+++ /home/runner/work/waves/waves/build/docs/tutorial_cubit_SConstruct
@@ -1,7 +1,10 @@
 #! /usr/bin/env python
 
 import os
+import sys
+import typing
 import pathlib
+import subprocess
 
 import waves
 
@@ -48,6 +51,20 @@
     metavar="COMMAND",
     help=f"Override for the Abaqus command. Repeat to specify more than one (default: {default_abaqus_commands})",
 )
+default_cubit_commands = [
+    "/apps/Cubit-16.12/cubit",
+    "/usr/projects/ea/Cubit/Cubit-16.12/cubit",
+    "cubit",
+]
+AddOption(
+    "--cubit-command",
+    dest="cubit_command",
+    nargs=1,
+    type="string",
+    action="append",
+    metavar="COMMAND",
+    help=f"Override for the Cubit command. Repeat to specify more than one (default: {default_cubit_commands})",
+)
 
 # Comments used in tutorial code snippets: marker-2
 
@@ -58,6 +75,7 @@
     unconditional_build=GetOption("unconditional_build"),
     print_build_failures=GetOption("print_build_failures"),
     abaqus_commands=GetOption("abaqus_command"),
+    cubit_commands=GetOption("cubit_command"),
 )
 
 # Conditionally print failed task *.stdout files
@@ -69,6 +87,28 @@
 env["ABAQUS_PROGRAM"] = env.AddProgram(
     env["abaqus_commands"] if env["abaqus_commands"] is not None else default_abaqus_commands
 )
+env["CUBIT_PROGRAM"] = env.AddCubit(
+    env["cubit_commands"] if env["cubit_commands"] is not None else default_cubit_commands
+)
+env["FIERRO_IMPLICIT_PROGRAM"] = env.AddProgram(["fierro-parallel-implicit"])
+
+
+# Sierra requires a separate construction environment
+def return_modulepath(modules: typing.Iterable[str]) -> pathlib.Path:
+    """Return parent path of first found module or the current working directory"""
+    return next((pathlib.Path(path).parent for path in modules if pathlib.Path(path).exists()), pathlib.Path("."))
+
+
+sierra_modules = [
+    "/projects/aea_compute/modulefiles/sierra/5.21.6",
+]
+sierra_modulefile_parent = return_modulepath(sierra_modules)
+try:
+    envSierra = waves.scons_extensions.shell_environment(f"module use {sierra_modulefile_parent} && module load sierra")
+except subprocess.CalledProcessError:
+    print("Failed to initialize the Sierra environment", file=sys.stderr)
+    envSierra = Environment()
+envSierra["sierra"] = waves.scons_extensions.add_program(envSierra, ["sierra"])
 
 # Comments used in tutorial code snippets: marker-4
 
@@ -84,26 +124,33 @@
 for key, value in project_variables.items():
     env[key] = value
 
-# Make the project package importable for Python and Abaqus Python environments
-env.PrependENVPath("PYTHONPATH", project_dir)
-
 # Comments used in tutorial code snippets: marker-5
 
 # Add builders and pseudo-builders
 env.Append(BUILDERS={})
 
+envSierra.Append(
+    BUILDERS={
+        "Sierra": waves.scons_extensions.sierra_builder_factory(program=envSierra["sierra"]),
+    }
+)
+
 # Comments used in tutorial code snippets: marker-6
 
 # Add simulation targets
 workflow_configurations = [
-    "tutorial_01_geometry",
-    "tutorial_02_partition_mesh",
-    "tutorial_03_solverprep",
-    "tutorial_04_simulation",
+    "abaqus",
+    "sierra",
+    "fierro",
 ]
 for workflow in workflow_configurations:
     build_dir = env["variant_dir_base"] / workflow
-    SConscript(workflow, variant_dir=build_dir, exports={"env": env}, duplicate=False)
+    SConscript(
+        workflow,
+        variant_dir=build_dir,
+        exports={"env": env, "envSierra": envSierra},
+        duplicate=False,
+    )
 
 # Comments used in tutorial code snippets: marker-7
 

Note that the Cubit Python files don’t perform any imports from the current modsim project package, so the PYTHONPATH modification is no longer required. This tutorial is created in a new, stand-alone subdirectory, so the previous tutorial workflow configurations are no longer available. Only the sierra and abaqus workflow configurations will be found by SCons at execution time. Finally, note that the cubit SConscript file is not called by the SConstruct file. Instead, the cubit configuration is reused by the sierra and abaqus workflows, so the Cubit tasks only need to be defined once. To handle this task reuse some additional variable import and export statements are required by the cubit configuration file.

Build Targets

8. Build the new targets

$ pwd
/home/roppenheimer/waves-tutorials/tutorial_cubit
$ scons abaqus
scons: Reading SConscript files ...
Checking whether /apps/abaqus/Commands/abq2024 program exists.../apps/abaqus/Commands/abq2024
Checking whether abq2024 program exists...no
Checking whether /apps/Cubit-16.12/cubit program exists.../apps/Cubit-16.12/cubit
Checking whether cubit program exists...no
Checking whether sierra program exists...no
scons: done reading SConscript files.
scons: Building targets ...
Copy("build/abaqus/rectangle_compression.inp", "modsim_package/abaqus/rectangle_compression.inp")
Copy("build/abaqus/assembly.inp", "modsim_package/abaqus/assembly.inp")
Copy("build/abaqus/boundary.inp", "modsim_package/abaqus/boundary.inp")
Copy("build/abaqus/field_output.inp", "modsim_package/abaqus/field_output.inp")
Copy("build/abaqus/materials.inp", "modsim_package/abaqus/materials.inp")
Copy("build/abaqus/parts.inp", "modsim_package/abaqus/parts.inp")
Copy("build/abaqus/history_output.inp", "modsim_package/abaqus/history_output.inp")
cd /home/roppenheimer/waves-tutorials/tutorial_cubit/build/abaqus && python /home/roppenheimer/waves-tutorials/tutorial_cubit/modsim_package/cubit/rectangle_geometry.py > rectangle_geometry.stdout 2>&1
cd /home/roppenheimer/waves-tutorials/tutorial_cubit/build/abaqus && python /home/roppenheimer/waves-tutorials/tutorial_cubit/modsim_package/cubit/rectangle_partition.py > rectangle_partition.stdout 2>&1
cd /home/roppenheimer/waves-tutorials/tutorial_cubit/build/abaqus && python /home/roppenheimer/waves-tutorials/tutorial_cubit/modsim_package/cubit/rectangle_mesh.py > rectangle_mesh.stdout 2>&1
cd /home/roppenheimer/waves-tutorials/tutorial_cubit/build/abaqus && /apps/abaqus/Commands/abq2024 -job rectangle_compression -input rectangle_compression -double both -interactive -ask_delete no > rectangle_compression.stdout 2>&1
scons: done building targets.

Output Files

Explore the contents of the build directory using the tree command against the build/abaqus directory, as shown below.

$ pwd
/home/roppenheimer/waves-tutorials/tutorial_cubit
$ tree build/abaqus
build/abaqus
|-- assembly.inp
|-- boundary.inp
|-- field_output.inp
|-- history_output.inp
|-- materials.inp
|-- parts.inp
|-- rectangle_compression.com
|-- rectangle_compression.dat
|-- rectangle_compression.inp
|-- rectangle_compression.msg
|-- rectangle_compression.odb
|-- rectangle_compression.prt
|-- rectangle_compression.sta
|-- rectangle_compression.stdout
|-- rectangle_geometry.cub
|-- rectangle_geometry.stdout
|-- rectangle_mesh.cub
|-- rectangle_mesh.inp
|-- rectangle_mesh.stdout
|-- rectangle_partition.cub
`-- rectangle_partition.stdout

0 directories, 21 files