Simplify constitution (#881)

CHANGELOG.md

@@ -10,9 +10,9 @@ All notable changes to this project will be documented in this file. The format
 - Add optional keyword-arguments to `math.transpose(**kwargs)` to support optional `out` and `order`-keywords.
 - Add the attribute `RegionBoundary.tangents`, which contains a list of tangent unit vectors. For `quad` cell-types the length of this list is one and for `hexahedron` cell-types it is of length two.
 - Add `math.inplane(A, vectors)` to return the in-plane components of a symmetric tensor `A`, where the plane is defined by its standard unit vectors.
-- Add `constitution.autodiff.jax.Hyperelastic` as a feature-equivalent alternative to `Hyperelastic` with `jax` as backend.
-- Add `constitution.autodiff.jax.Material` as a feature-equivalent alternative to `MaterialAD` with `jax` as backend.
-- Add the MORPH-material formulation for a JAX-based material `felupe.constitution.autodiff.jax.models.lagrange.morph()`.
+- Add `constitution.jax.Hyperelastic` as a feature-equivalent alternative to `Hyperelastic` with `jax` as backend.
+- Add `constitution.jax.Material` as a feature-equivalent alternative to `MaterialAD` with `jax` as backend.
+- Add the MORPH-material formulation for a JAX-based material `felupe.constitution.jax.models.lagrange.morph()`.
 
 ### Changed
 - Change default `np.einsum(..., order="K")` to `np.einsum(..., order="C")` in the methods of `Field`, `FieldAxisymmetric`, `FieldPlaneStrain` and `FieldContainer`.

docs/felupe/constitution/jax.rst

@@ -11,33 +11,33 @@ This page contains material model formulations with automatic differentiation us
 
 .. autosummary::
 
-   constitution.autodiff.jax.Hyperelastic
-   constitution.autodiff.jax.Material
+   constitution.jax.Hyperelastic
+   constitution.jax.Material
 
-**Material Models for** :class:`felupe.constitution.autodiff.jax.Material`
+**Material Models for** :class:`felupe.constitution.jax.Material`
 
 .. autosummary::
 
-   felupe.constitution.autodiff.jax.models.lagrange.morph
+   felupe.constitution.jax.models.lagrange.morph
 
 **Tools**
 
 .. autosummary::
 
-   constitution.autodiff.jax.vmap
+   constitution.jax.vmap
 
 **Detailed API Reference**
 
-.. autoclass:: felupe.constitution.autodiff.jax.Hyperelastic
+.. autoclass:: felupe.constitution.jax.Hyperelastic
    :members:
    :undoc-members:
    :inherited-members:
 
-.. autoclass:: felupe.constitution.autodiff.jax.Material
+.. autoclass:: felupe.constitution.jax.Material
    :members:
    :undoc-members:
    :inherited-members:
 
-.. autofunction:: felupe.constitution.autodiff.jax.models.lagrange.morph
+.. autofunction:: felupe.constitution.jax.models.lagrange.morph
 
-.. autofunction:: felupe.constitution.autodiff.jax.vmap
+.. autofunction:: felupe.constitution.jax.vmap

docs/felupe/constitution/lagrange.rst

@@ -34,7 +34,7 @@ This page contains Total- and Updated-Lagrange material formulations with automa
    :undoc-members:
    :inherited-members:
 
-.. autoclass:: felupe.constitution.autodiff.tensortrax.Material
+.. autoclass:: felupe.constitution.tensortrax.Material
    :members:
    :undoc-members:
    :inherited-members:

src/felupe/constitution/__init__.py

@@ -3,28 +3,6 @@
 from ._material import Material
 from ._mixed import NearlyIncompressible, ThreeFieldVariation
 from ._view import ViewMaterial, ViewMaterialIncompressible
-from .autodiff.tensortrax import Hyperelastic
-from .autodiff.tensortrax import Material as MaterialAD
-from .autodiff.tensortrax import total_lagrange, updated_lagrange
-from .autodiff.tensortrax.models.hyperelastic import (
-    alexander,
-    anssari_benam_bucchi,
-    arruda_boyce,
-    extended_tube,
-    finite_strain_viscoelastic,
-    isochoric_volumetric_split,
-    lopez_pamies,
-    miehe_goektepe_lulei,
-    mooney_rivlin,
-    neo_hooke,
-    ogden,
-    ogden_roxburgh,
-    saint_venant_kirchhoff,
-    third_order_deformation,
-    van_der_waals,
-    yeoh,
-)
-from .autodiff.tensortrax.models.lagrange import morph, morph_representative_directions
 from .hyperelasticity import NeoHooke, NeoHookeCompressible, OgdenRoxburgh, Volumetric
 from .linear_elasticity import (
     LinearElastic,
@@ -42,6 +20,28 @@
     linear_elastic,
     linear_elastic_plastic_isotropic_hardening,
 )
+from .tensortrax import Hyperelastic
+from .tensortrax import Material as MaterialAD
+from .tensortrax import total_lagrange, updated_lagrange
+from .tensortrax.models.hyperelastic import (
+    alexander,
+    anssari_benam_bucchi,
+    arruda_boyce,
+    extended_tube,
+    finite_strain_viscoelastic,
+    isochoric_volumetric_split,
+    lopez_pamies,
+    miehe_goektepe_lulei,
+    mooney_rivlin,
+    neo_hooke,
+    ogden,
+    ogden_roxburgh,
+    saint_venant_kirchhoff,
+    third_order_deformation,
+    van_der_waals,
+    yeoh,
+)
+from .tensortrax.models.lagrange import morph, morph_representative_directions
 
 __all__ = [
     "alexander",

src/felupe/constitution/autodiff/jax/_hyperelastic.py → src/felupe/constitution/jax/_hyperelastic.py

@@ -20,7 +20,7 @@
 
 import numpy as np
 
-from ..._material import Material
+from .._material import Material
 from ._tools import total_lagrange, vmap2
 
 
@@ -72,7 +72,7 @@ def neo_hooke(C, mu):
             "Strain energy function of the Neo-Hookean material formulation."
             return mu / 2 * (jnp.linalg.det(C) ** (-1/3) * jnp.trace(C) - 3)
 
-        umat = fem.constitution.autodiff.jax.Hyperelastic(neo_hooke, mu=1)
+        umat = fem.constitution.jax.Hyperelastic(neo_hooke, mu=1)
 
     and this code-block for material formulations with state variables.
 
@@ -83,6 +83,7 @@ def neo_hooke(C, mu):
     ..  code-block::
 
         import felupe as fem
+        import felupe.constitution.jax as mat
         import jax.numpy as np
 
         def viscoelastic(C, Cin, mu, eta, dtime):
@@ -101,9 +102,7 @@ def viscoelastic(C, Cin, mu, eta, dtime):
             # strain energy function and state variable
             return mu / 2 * (I1 - 3), Ci.ravel()
 
-        umat = fem.constitution.autodiff.jax.Hyperelastic(
-            viscoelastic, mu=1, eta=1, dtime=1, nstatevars=9
-        )
+        umat = mat.Hyperelastic(viscoelastic, mu=1, eta=1, dtime=1, nstatevars=9)
 
     ..  note::
         See the `documentation of JAX <https://jax.readthedocs.io>`_ for further
@@ -120,13 +119,14 @@ def viscoelastic(C, Cin, mu, eta, dtime):
         :context:
 
         >>> import felupe as fem
+        >>> import felupe.constitution.jax as mat
         >>> import jax.numpy as jnp
         >>>
         >>> def neo_hooke(C, mu):
         ...     "Strain energy function of the Neo-Hookean material formulation."
         ...     return mu / 2 * (jnp.linalg.det(C) ** (-1/3) * jnp.trace(C) - 3)
         >>>
-        >>> umat = fem.constitution.autodiff.jax.Hyperelastic(neo_hooke, mu=1)
+        >>> umat = mat.Hyperelastic(neo_hooke, mu=1)
         >>> ax = umat.plot(incompressible=True)
 
     ..  pyvista-plot::

src/felupe/constitution/autodiff/jax/_material.py → src/felupe/constitution/jax/_material.py

@@ -20,7 +20,7 @@
 
 import numpy as np
 
-from ..._material import Material as MaterialDefault
+from .._material import Material as MaterialDefault
 from ._tools import vmap2
 
 
@@ -63,6 +63,7 @@ class Material(MaterialDefault):
     ..  code-block::
 
         import felupe as fem
+        import felupe.constitution.jax as mat
         import jax.numpy as jnp
 
         def neo_hooke(F, mu):
@@ -74,13 +75,14 @@ def neo_hooke(F, mu):
 
             return mu * F @ dev(Cu) @ jnp.linalg.inv(C)
 
-        umat = fem.constitution.autodiff.jax.Material(neo_hooke, mu=1)
+        umat = mat.Material(neo_hooke, mu=1)
 
     and this code-block for material formulations with state variables:
 
     ..  code-block::
 
         import felupe as fem
+        import felupe.constitution.jax as mat
         import jax.numpy as jnp
 
         def viscoelastic(F, Cin, mu, eta, dtime):
@@ -104,9 +106,7 @@ def viscoelastic(F, Cin, mu, eta, dtime):
             to_triu = lambda C: C[i, j]
             return F @ S, to_triu(Ci)
 
-        umat = fem.constitution.autodiff.jax.Material(
-            viscoelastic, mu=1, eta=1, dtime=1, nstatevars=6
-        )
+        umat = mat.Material(viscoelastic, mu=1, eta=1, dtime=1, nstatevars=6)
 
     ..  note::
         See the `documentation of JAX <https://jax.readthedocs.io>`_ for further
@@ -123,6 +123,7 @@ def viscoelastic(F, Cin, mu, eta, dtime):
         :context:
 
         >>> import felupe as fem
+        >>> import felupe.constitution.jax as mat
         >>> import jax.numpy as jnp
         >>>
         >>> def neo_hooke(F, mu):
@@ -134,7 +135,7 @@ def viscoelastic(F, Cin, mu, eta, dtime):
         ...
         ...     return mu * F @ dev(Cu) @ jnp.linalg.inv(C)
         >>>
-        >>> umat = fem.constitution.autodiff.jax.Material(neo_hooke, mu=1)
+        >>> umat = mat.Material(neo_hooke, mu=1)
         >>> ax = umat.plot(incompressible=True)
 
     ..  pyvista-plot::

src/felupe/constitution/autodiff/jax/models/lagrange/_morph.py → src/felupe/constitution/jax/models/lagrange/_morph.py

@@ -122,9 +122,10 @@ def morph(F, statevars, p):
         :context:
 
         >>> import felupe as fem
+        >>> import felupe.constitution.jax as mat
         >>>
-        >>> umat = fem.constitution.autodiff.jax.Material(
-        ...     fem.constitution.autodiff.jax.models.lagrange.morph,
+        >>> umat = mat.Material(
+        ...     mat.models.lagrange.morph,
         ...     p=[0.039, 0.371, 0.174, 2.41, 0.0094, 6.84, 5.65, 0.244],
         ...     nstatevars=13,
         ... )

src/felupe/constitution/autodiff/tensortrax/_hyperelastic.py → src/felupe/constitution/tensortrax/_hyperelastic.py

@@ -19,8 +19,8 @@
 import numpy as np
 import tensortrax as tr
 
-from ....math import cdya_ik, dot, transpose
-from ..._material import Material
+from ...math import cdya_ik, dot, transpose
+from .._material import Material
 
 
 class Hyperelastic(Material):

src/felupe/constitution/autodiff/tensortrax/_material.py → src/felupe/constitution/tensortrax/_material.py

@@ -19,7 +19,7 @@
 import numpy as np
 import tensortrax as tr
 
-from ..._material import Material as MaterialDefault
+from .._material import Material as MaterialDefault
 
 
 class Material(MaterialDefault):
@@ -66,6 +66,7 @@ class Material(MaterialDefault):
     ..  code-block::
 
         import felupe as fem
+        import felupe.constitution.tensortrax as mat
         import tensortrax.math as tm
 
         def neo_hooke(F, mu):
@@ -76,13 +77,14 @@ def neo_hooke(F, mu):
 
             return mu * F @ tm.special.dev(Cu) @ tm.linalg.inv(C)
 
-        umat = fem.MaterialAD(neo_hooke, mu=1)
+        umat = mat.Material(neo_hooke, mu=1)
 
     and this code-block for material formulations with state variables:
 
     ..  code-block::
 
         import felupe as fem
+        import felupe.constitution.tensortrax as mat
         import tensortrax.math as tm
 
         def viscoelastic(F, Cin, mu, eta, dtime):
@@ -102,9 +104,7 @@ def viscoelastic(F, Cin, mu, eta, dtime):
             # first Piola-Kirchhoff stress tensor and state variable
             return F @ S, tm.special.triu_1d(Ci)
 
-        umat = fem.MaterialAD(
-            viscoelastic, mu=1, eta=1, dtime=1, nstatevars=6
-        )
+        umat = mat.Material(viscoelastic, mu=1, eta=1, dtime=1, nstatevars=6)
 
     ..  note::
         See the `documentation of tensortrax <https://github.com/adtzlr/tensortrax>`_
@@ -116,14 +116,15 @@ def viscoelastic(F, Cin, mu, eta, dtime):
         :context:
 
         >>> import felupe as fem
+        >>> import felupe.constitution.tensortrax as mat
         >>> import tensortrax.math as tm
         >>>
         >>> def neo_hooke(F, mu):
         ...     C = tm.dot(tm.transpose(F), F)
         ...     S = mu * tm.special.dev(tm.linalg.det(C)**(-1/3) * C) @ tm.linalg.inv(C)
         ...     return F @ S
         >>>
-        >>> umat = fem.MaterialAD(neo_hooke, mu=1)
+        >>> umat = mat.Material(neo_hooke, mu=1)
         >>> ax = umat.plot(incompressible=True)
 
     ..  pyvista-plot::

src/felupe/constitution/autodiff/tensortrax/models/hyperelastic/_morph_representative_directions.py → src/felupe/constitution/tensortrax/models/hyperelastic/_morph_representative_directions.py

@@ -43,7 +43,7 @@ def morph_representative_directions(C, statevars, p, ε=1e-8):
         :context:
 
         >>> import felupe as fem
-        >>> import felupe.constitution.autodiff.tensortrax.models as models
+        >>> import felupe.constitution.tensortrax.models as models
         >>>
         >>> umat = fem.Hyperelastic(
         ...     models.hyperelastic.morph_representative_directions,

src/felupe/constitution/autodiff/tensortrax/models/hyperelastic/microsphere/_framework_affine.py → src/felupe/constitution/tensortrax/models/hyperelastic/microsphere/_framework_affine.py

@@ -1,7 +1,7 @@
 from tensortrax.math import einsum, sqrt
 from tensortrax.math.linalg import det, inv
 
-from .......quadrature import BazantOh
+from ......quadrature import BazantOh
 
 
 def affine_stretch(C, f, kwargs, quadrature=BazantOh(n=21)):

src/felupe/constitution/autodiff/tensortrax/models/hyperelastic/microsphere/_framework_nonaffine.py → src/felupe/constitution/tensortrax/models/hyperelastic/microsphere/_framework_nonaffine.py

@@ -1,7 +1,7 @@
 from tensortrax.math import einsum, sqrt
 from tensortrax.math.linalg import det, inv
 
-from .......quadrature import BazantOh
+from ......quadrature import BazantOh
 
 
 def nonaffine_stretch(C, p, f, kwargs, quadrature=BazantOh(n=21)):

src/felupe/constitution/autodiff/tensortrax/models/lagrange/microsphere/_framework_affine.py → src/felupe/constitution/tensortrax/models/lagrange/microsphere/_framework_affine.py

@@ -1,7 +1,7 @@
 from tensortrax.math import einsum, sqrt, trace
 from tensortrax.math.linalg import det, inv
 
-from .......quadrature import BazantOh
+from ......quadrature import BazantOh
 from ...._total_lagrange import total_lagrange
 
 

tests/test_constitution.py

@@ -29,7 +29,7 @@
 import pytest
 
 import felupe as fem
-import felupe.constitution.autodiff.tensortrax.models as models
+import felupe.constitution.tensortrax.models as models
 
 
 def pre(sym, add_identity, add_random=False):