From 1fd37bdcc8a9edac481470e7ab1295b82d01074d Mon Sep 17 00:00:00 2001 From: Chandu Bolisetti Date: Fri, 11 Jun 2021 17:51:45 -0600 Subject: [PATCH] Addressing @somu15 comments. --- .../source/auxkernels/MaterialRealCMMAux.md | 21 ++++--------------- 1 file changed, 4 insertions(+), 17 deletions(-) diff --git a/doc/content/source/auxkernels/MaterialRealCMMAux.md b/doc/content/source/auxkernels/MaterialRealCMMAux.md index 26e9041d60..34ca04fad6 100644 --- a/doc/content/source/auxkernels/MaterialRealCMMAux.md +++ b/doc/content/source/auxkernels/MaterialRealCMMAux.md @@ -4,26 +4,13 @@ ## Description -`MaterialRealCMMAux` can be used to populate an `AuxVariable` with an element of -a material property that is of type, ColumnMajorMatrix (CMM). In MASTODON, a -common use case is accessing the deformation or force CMMs from link elements -when the [`LinearSpring`](source/materials/LinearSpring.md) material or any of -the seismic isolator materials (e.g., [`ComputeFPIsolatorElasticity`](source/materials/ComputeFPIsolatorElasticity.md)) is used. This `AuxKernel` and the corresponding -`AuxVariable` should be block-restricted to blocks where the material property -given by the `property` input parameter below is defined. - -For example, the following input file syntax will create the AuxVariable field -called `global_force_x` with the X direction force in the spring element modeled -using the LinearSpring material. The AuxKernel is defined as follows: +`MaterialRealCMMAux` can be used to populate an `AuxVariable` with an element of a material property that is of type, ColumnMajorMatrix (CMM). In MASTODON, a common use case is accessing the deformation or force CMMs from link elements when the [`LinearSpring`](source/materials/LinearSpring.md) material or any of the seismic isolator materials (e.g., [`ComputeFPIsolatorElasticity`](source/materials/ComputeFPIsolatorElasticity.md)) is used. This `AuxKernel` and the corresponding `AuxVariable` should be block-restricted to blocks where the material property given by the `property` input parameter below is defined. + +For example, the following input file syntax will create the AuxVariable field called `global_force_x` with the X direction force in the spring element modeled using the LinearSpring material. Users can look at the LinearSpring.C file in the source code to see that this material has several material properties such as "global_forces", "global_moments", etc. In the case of the linear spring material, the "global_forces" material property is a CMM of size 6x1 and stores the forces in the spring in the global co-ordinate system. The AuxKernel to make this calculation is listed below. !listing test/tests/auxkernels/materialrealcmm/spring_static.i block=AuxKernels -In this input, the AuxKernel takes the element (0, 0) from the CMM material -property named, "ls_global_forces". This material property name refers to the -global forces in the linear spring material. (See LinearSpring.C for other -material properties.) In this example, the linear spring material is only defined -in block '0' and therefore this AuxKernel and AuxVariable are also restricted to -this block. +In this input, the AuxKernel takes the element (0, 0) from the CMM material property named, "global_forces" in the linear spring material. (See LinearSpring.C for other material properties.) In this example, the linear spring material is only defined in block '0' and therefore this AuxKernel and AuxVariable are also restricted to this block. The element (0, 0) of the material property "global_forces" corresponds to the axial force in the spring. Currently, in order to know what each of the elements in a material property CMM correspond to, users will either have to go through the source code or reach out to one of the MASTODON developers [here](help/contact_us.md). !syntax parameters /AuxKernels/MaterialRealCMMAux