deploy: 271902e

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b14d71cad9123660211f04be2c9fdd65
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/compilation/compilation.rst.txt

@@ -0,0 +1,99 @@
+Compiliation
+============
+
+CALIBR8 uses the `CApp <https://github.com/sandialabs/capp>`_
+build tool, which coordinates the entire build process. In particular,
+it acquires and builds all approriate third-party libraries.
+
+Requirements
+------------
+
+Install or (on HPC systems) load modules for required tools:
+
+  1. CMake (>3.21)
+  2. Git (>2.39)
+  3. C and C++ compilers (with C++17 support). If needed, use the
+     `CC` and `CXX` environment variables you want to distinguish them
+     from others in the `PATH`.
+  4. MPI with C and C++ compiler support
+  5. Python 3
+  6. Ensure that you have SSH keys set up for `GitHub <https://github.com>`_
+     on the machine you are using.
+
+Scripts to set up this environment are provided for some common platforms:
+
+============================   ================================================
+Command                        Platform
+============================   ================================================
+`source env/linux-shared.sh`   Generic LINUX environments with shared libraries
+`source env/osx-static.sh`     Mac laptop with static libraries
+`source env/osx-shared.sh`     Mac laptop with shared libraries
+`source env/cee-static.sh`     CEE workstations with static libraries
+`source env/cee-shared.sh`     CEE workstations with shared libraries
+`source env/toss3-static.sh`   TOSS3 capacity clusters 
+============================   ================================================
+
+Choose a flavor
+---------------
+
+"Flavors" in CApp control different 'variants' of the build. In many CApp
+projects, a flavor corresponds to the underlying HPC architecture and compile
+options (e.g. v100 GPUs, A100 APUs, etc..). Presently, we slightly abuse this
+notion of a flavor to simply offer users a convenient way to build on specific
+machines.
+
+============================   ================================================
+Flavor                         Description 
+============================   ================================================
+`linux-shared`                 LINUX environments with shared libraries
+`cee-shared`                   CEE environments with shared libraries
+`cee-static`                   CEE environments with static libraries
+`osx-static`                   Mac environments with static libraries
+`osx-shared`                   Mac environments with shared libraries
+`toss3-static`                 TOSS3 capacity clusters
+============================   ================================================
+
+If you used one of the environment scripts in the `env/` subdirectory, it also
+exports an environment variable `CAPP_FLAVOR` with the most appropriate flavor
+for this platform. If you are setting up your own environment, then you can
+export this environment variable
+
+.. code-block:: bash
+
+  export CAPP_FLAVOR=linx-shared
+
+Source the CApp setup script
+----------------------------
+
+.. code-block:: bash
+
+  source capp-setup.sh
+
+Run the CApp command
+--------------------
+
+Once the CApp setup script has been sourced, you can run the CApp command,
+optionally specifying the number of cores to compile with (`-j`) and
+HTTP proxy if necessary (`--proxy`):
+
+.. code-block:: bash
+
+  capp build -j 4 --proxy http://proxy.sandia.gov:80
+
+Load the CALIBR8 environment
+----------------------------
+
+Assuming everything goes well, you can put the `CALIBR8` code  into your
+`PATH` and a `python` interpreter that has access to all the relevant
+Python modules with the CApp `load` command:
+
+.. code-block:: bash
+
+  capp load
+
+Conversely, you can "tear down" (remove these from your `PATH`) the
+enviroment using:
+
+.. code-block:: bash
+
+  capp unload

_sources/index.rst.txt

@@ -0,0 +1,15 @@
+.. _index:
+
+=======
+Welcome
+=======
+
+Welcome to the Calibr8 documentation.
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Table of Contents:
+
+    compilation/compilation
+    usage/usage
+    theory/theory

_sources/theory/theory.rst.txt

@@ -0,0 +1,27 @@
+Theory
+======
+
+Governing Equations
+-------------------
+
+At its core, CALIBR8 is concerned with solving the balance of linear momentum in the
+absence of inertial terms for finite-deformation mechanics in a total-Lagrangian setting.
+This can be represented as
+
+.. math::
+
+  \begin{aligned}
+  \begin{cases}
+  - \nabla \cdot \boldsymbol{P} &= 0, &&\text{in} \quad \mathcal{B}, \\
+  \boldsymbol{u} &= \boldsymbol{g}, &&\text{on} \quad \Gamma_g, \\
+  \boldsymbol{P} \cdot \boldsymbol{N} &= \boldsymbol{h}, &&\text{on} \quad \Gamma_h.
+  \end{cases}
+  \end{aligned}
+
+where
+:math:`\boldsymbol{P}` denotes the first Piola-Kirchhoff stress tensor
+:math:`\mathcal{B}` denotes the domain of interest in the reference configuration,
+:math:`\Gamma_g` denotes the portion of the domain boundary on which Dirichlet boundary
+conditions :math:`\boldsymbol{u}` are prescribed, and :math:`\Gamma_h` denotes the portion
+of the domain boundary on which tractions
+:math:`\boldsymbol{P} \cdot \boldsymbol{N}` are prescribed,

_sources/usage/forward.rst.txt

@@ -0,0 +1,5 @@
+.. _forward:
+
+=========================
+Running a forward problem
+=========================

_sources/usage/usage.rst.txt

@@ -0,0 +1,15 @@
+.. _usage:
+
+=====
+Usage
+=====
+
+This page documents intended use cases of the CALIBR8
+code. The most basic building block of CALIBR8 is the
+forward model problem.
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Table of Contents:
+
+    forward.rst

_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}