xref: /libCEED/rust/libceed-sys/c-src/interface/ceed-elemrestriction.c (revision 1c66c397a67401e1a222857807e6e5b7c45b88c0)
13d8e8822SJeremy L Thompson // Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors.
23d8e8822SJeremy L Thompson // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
3d7b241e6Sjeremylt //
43d8e8822SJeremy L Thompson // SPDX-License-Identifier: BSD-2-Clause
5d7b241e6Sjeremylt //
63d8e8822SJeremy L Thompson // This file is part of CEED:  http://github.com/ceed
7d7b241e6Sjeremylt 
83d576824SJeremy L Thompson #include <ceed-impl.h>
949aac155SJeremy L Thompson #include <ceed.h>
102b730f8bSJeremy L Thompson #include <ceed/backend.h>
113d576824SJeremy L Thompson #include <stdbool.h>
123d576824SJeremy L Thompson #include <stdio.h>
13c17ec2beSJeremy L Thompson #include <string.h>
14d7b241e6Sjeremylt 
157a982d89SJeremy L. Thompson /// @file
167a982d89SJeremy L. Thompson /// Implementation of CeedElemRestriction interfaces
177a982d89SJeremy L. Thompson 
187a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
197a982d89SJeremy L. Thompson /// CeedElemRestriction Library Internal Functions
207a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
217a982d89SJeremy L. Thompson /// @addtogroup CeedElemRestrictionDeveloper
227a982d89SJeremy L. Thompson /// @{
237a982d89SJeremy L. Thompson 
247a982d89SJeremy L. Thompson /**
25d979a051Sjeremylt   @brief Permute and pad offsets for a blocked restriction
267a982d89SJeremy L. Thompson 
27fcbe8c06SSebastian Grimberg   @param[in]  offsets        Array of shape [@a num_elem, @a elem_size].
28e7f679fcSJeremy L Thompson   @param[out] block_offsets  Array of permuted and padded array values of shape [@a num_block, @a elem_size, @a block_size].
29e7f679fcSJeremy L Thompson   @param[in]  num_block      Number of blocks
30ea61e9acSJeremy L Thompson   @param[in]  num_elem       Number of elements
31e7f679fcSJeremy L Thompson   @param[in]  block_size     Number of elements in a block
32ea61e9acSJeremy L Thompson   @param[in]  elem_size      Size of each element
337a982d89SJeremy L. Thompson 
347a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
357a982d89SJeremy L. Thompson 
367a982d89SJeremy L. Thompson   @ref Utility
377a982d89SJeremy L. Thompson **/
38e7f679fcSJeremy L Thompson int CeedPermutePadOffsets(const CeedInt *offsets, CeedInt *block_offsets, CeedInt num_block, CeedInt num_elem, CeedInt block_size,
39e7f679fcSJeremy L Thompson                           CeedInt elem_size) {
40e7f679fcSJeremy L Thompson   for (CeedInt e = 0; e < num_block * block_size; e += block_size) {
41e7f679fcSJeremy L Thompson     for (CeedInt j = 0; j < block_size; j++) {
422b730f8bSJeremy L Thompson       for (CeedInt k = 0; k < elem_size; k++) {
43e7f679fcSJeremy L Thompson         block_offsets[e * elem_size + k * block_size + j] = offsets[CeedIntMin(e + j, num_elem - 1) * elem_size + k];
442b730f8bSJeremy L Thompson       }
452b730f8bSJeremy L Thompson     }
462b730f8bSJeremy L Thompson   }
47e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
487a982d89SJeremy L. Thompson }
497a982d89SJeremy L. Thompson 
5077d1c127SSebastian Grimberg /**
5177d1c127SSebastian Grimberg   @brief Permute and pad orientations for a blocked restriction
5277d1c127SSebastian Grimberg 
53fcbe8c06SSebastian Grimberg   @param[in]  orients       Array of shape [@a num_elem, @a elem_size].
54e7f679fcSJeremy L Thompson   @param[out] block_orients Array of permuted and padded array values of shape [@a num_block, @a elem_size, @a block_size].
55e7f679fcSJeremy L Thompson   @param[in]  num_block     Number of blocks
5677d1c127SSebastian Grimberg   @param[in]  num_elem      Number of elements
57e7f679fcSJeremy L Thompson   @param[in]  block_size    Number of elements in a block
5877d1c127SSebastian Grimberg   @param[in]  elem_size     Size of each element
5977d1c127SSebastian Grimberg 
6077d1c127SSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
6177d1c127SSebastian Grimberg 
6277d1c127SSebastian Grimberg   @ref Utility
6377d1c127SSebastian Grimberg **/
64e7f679fcSJeremy L Thompson int CeedPermutePadOrients(const bool *orients, bool *block_orients, CeedInt num_block, CeedInt num_elem, CeedInt block_size, CeedInt elem_size) {
65e7f679fcSJeremy L Thompson   for (CeedInt e = 0; e < num_block * block_size; e += block_size) {
66e7f679fcSJeremy L Thompson     for (CeedInt j = 0; j < block_size; j++) {
6777d1c127SSebastian Grimberg       for (CeedInt k = 0; k < elem_size; k++) {
68e7f679fcSJeremy L Thompson         block_orients[e * elem_size + k * block_size + j] = orients[CeedIntMin(e + j, num_elem - 1) * elem_size + k];
6977d1c127SSebastian Grimberg       }
7077d1c127SSebastian Grimberg     }
7177d1c127SSebastian Grimberg   }
7277d1c127SSebastian Grimberg   return CEED_ERROR_SUCCESS;
7377d1c127SSebastian Grimberg }
7477d1c127SSebastian Grimberg 
750c73c039SSebastian Grimberg /**
760c73c039SSebastian Grimberg   @brief Permute and pad curl-conforming orientations for a blocked restriction
770c73c039SSebastian Grimberg 
780c73c039SSebastian Grimberg   @param[in]  curl_orients       Array of shape [@a num_elem, @a 3 * elem_size].
79e7f679fcSJeremy L Thompson   @param[out] block_curl_orients Array of permuted and padded array values of shape [@a num_block, @a elem_size, @a block_size].
80e7f679fcSJeremy L Thompson   @param[in]  num_block          Number of blocks
810c73c039SSebastian Grimberg   @param[in]  num_elem           Number of elements
82e7f679fcSJeremy L Thompson   @param[in]  block_size         Number of elements in a block
830c73c039SSebastian Grimberg   @param[in]  elem_size          Size of each element
840c73c039SSebastian Grimberg 
850c73c039SSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
860c73c039SSebastian Grimberg 
870c73c039SSebastian Grimberg   @ref Utility
880c73c039SSebastian Grimberg **/
89e7f679fcSJeremy L Thompson int CeedPermutePadCurlOrients(const CeedInt8 *curl_orients, CeedInt8 *block_curl_orients, CeedInt num_block, CeedInt num_elem, CeedInt block_size,
900c73c039SSebastian Grimberg                               CeedInt elem_size) {
91e7f679fcSJeremy L Thompson   for (CeedInt e = 0; e < num_block * block_size; e += block_size) {
92e7f679fcSJeremy L Thompson     for (CeedInt j = 0; j < block_size; j++) {
930c73c039SSebastian Grimberg       for (CeedInt k = 0; k < elem_size; k++) {
94e7f679fcSJeremy L Thompson         block_curl_orients[e * elem_size + k * block_size + j] = curl_orients[CeedIntMin(e + j, num_elem - 1) * elem_size + k];
950c73c039SSebastian Grimberg       }
960c73c039SSebastian Grimberg     }
970c73c039SSebastian Grimberg   }
980c73c039SSebastian Grimberg   return CEED_ERROR_SUCCESS;
990c73c039SSebastian Grimberg }
1000c73c039SSebastian Grimberg 
1017a982d89SJeremy L. Thompson /// @}
1027a982d89SJeremy L. Thompson 
1037a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
1047a982d89SJeremy L. Thompson /// CeedElemRestriction Backend API
1057a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
1067a982d89SJeremy L. Thompson /// @addtogroup CeedElemRestrictionBackend
1077a982d89SJeremy L. Thompson /// @{
1087a982d89SJeremy L. Thompson 
1097a982d89SJeremy L. Thompson /**
110fcbe8c06SSebastian Grimberg   @brief Get the type of a CeedElemRestriction
111a681ae63Sjeremylt 
112fcbe8c06SSebastian Grimberg   @param[in]  rstr      CeedElemRestriction
113fcbe8c06SSebastian Grimberg   @param[out] rstr_type Variable to store restriction type
114fcbe8c06SSebastian Grimberg 
115fcbe8c06SSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
116fcbe8c06SSebastian Grimberg 
117fcbe8c06SSebastian Grimberg   @ref Backend
118fcbe8c06SSebastian Grimberg **/
119fcbe8c06SSebastian Grimberg int CeedElemRestrictionGetType(CeedElemRestriction rstr, CeedRestrictionType *rstr_type) {
120fcbe8c06SSebastian Grimberg   *rstr_type = rstr->rstr_type;
121fcbe8c06SSebastian Grimberg   return CEED_ERROR_SUCCESS;
122fcbe8c06SSebastian Grimberg }
123fcbe8c06SSebastian Grimberg 
124fcbe8c06SSebastian Grimberg /**
125fcbe8c06SSebastian Grimberg   @brief Get the strided status of a CeedElemRestriction
126fcbe8c06SSebastian Grimberg 
127fcbe8c06SSebastian Grimberg   @param[in]  rstr       CeedElemRestriction
128fcbe8c06SSebastian Grimberg   @param[out] is_strided Variable to store strided status, 1 if strided else 0
129fcbe8c06SSebastian Grimberg **/
130fcbe8c06SSebastian Grimberg int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, bool *is_strided) {
131fcbe8c06SSebastian Grimberg   *is_strided = (rstr->rstr_type == CEED_RESTRICTION_STRIDED);
132fcbe8c06SSebastian Grimberg   return CEED_ERROR_SUCCESS;
133fcbe8c06SSebastian Grimberg }
134fcbe8c06SSebastian Grimberg 
135fcbe8c06SSebastian Grimberg /**
136a681ae63Sjeremylt   @brief Get the strides of a strided CeedElemRestriction
1377a982d89SJeremy L. Thompson 
138ea61e9acSJeremy L Thompson   @param[in]  rstr    CeedElemRestriction
139a681ae63Sjeremylt   @param[out] strides Variable to store strides array
1407a982d89SJeremy L. Thompson 
1417a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
1427a982d89SJeremy L. Thompson 
1437a982d89SJeremy L. Thompson   @ref Backend
1447a982d89SJeremy L. Thompson **/
1452b730f8bSJeremy L Thompson int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, CeedInt (*strides)[3]) {
1466574a04fSJeremy L Thompson   CeedCheck(rstr->strides, rstr->ceed, CEED_ERROR_MINOR, "ElemRestriction has no stride data");
1472b730f8bSJeremy L Thompson   for (CeedInt i = 0; i < 3; i++) (*strides)[i] = rstr->strides[i];
148e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1497a982d89SJeremy L. Thompson }
1507a982d89SJeremy L. Thompson 
1517a982d89SJeremy L. Thompson /**
15277d1c127SSebastian Grimberg   @brief Get the backend stride status of a CeedElemRestriction
15377d1c127SSebastian Grimberg 
15477d1c127SSebastian Grimberg   @param[in]  rstr                 CeedElemRestriction
15577d1c127SSebastian Grimberg   @param[out] has_backend_strides  Variable to store stride status
15677d1c127SSebastian Grimberg 
15777d1c127SSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
15877d1c127SSebastian Grimberg 
15977d1c127SSebastian Grimberg   @ref Backend
16077d1c127SSebastian Grimberg **/
16177d1c127SSebastian Grimberg int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, bool *has_backend_strides) {
16277d1c127SSebastian Grimberg   CeedCheck(rstr->strides, rstr->ceed, CEED_ERROR_MINOR, "ElemRestriction has no stride data");
16377d1c127SSebastian Grimberg   *has_backend_strides = ((rstr->strides[0] == CEED_STRIDES_BACKEND[0]) && (rstr->strides[1] == CEED_STRIDES_BACKEND[1]) &&
16477d1c127SSebastian Grimberg                           (rstr->strides[2] == CEED_STRIDES_BACKEND[2]));
16577d1c127SSebastian Grimberg   return CEED_ERROR_SUCCESS;
16677d1c127SSebastian Grimberg }
16777d1c127SSebastian Grimberg 
16877d1c127SSebastian Grimberg /**
169bd33150aSjeremylt   @brief Get read-only access to a CeedElemRestriction offsets array by memtype
170bd33150aSjeremylt 
171ea61e9acSJeremy L Thompson   @param[in]  rstr     CeedElemRestriction to retrieve offsets
172fcbe8c06SSebastian Grimberg   @param[in]  mem_type Memory type on which to access the array.
173fcbe8c06SSebastian Grimberg                          If the backend uses a different memory type, this will perform a copy (possibly cached).
174d1d35e2fSjeremylt   @param[out] offsets  Array on memory type mem_type
175bd33150aSjeremylt 
176bd33150aSjeremylt   @return An error code: 0 - success, otherwise - failure
177bd33150aSjeremylt 
178bd33150aSjeremylt   @ref User
179bd33150aSjeremylt **/
1802b730f8bSJeremy L Thompson int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **offsets) {
1817c1dbaffSSebastian Grimberg   if (rstr->rstr_base) {
1827c1dbaffSSebastian Grimberg     CeedCall(CeedElemRestrictionGetOffsets(rstr->rstr_base, mem_type, offsets));
183c17ec2beSJeremy L Thompson   } else {
1846574a04fSJeremy L Thompson     CeedCheck(rstr->GetOffsets, rstr->ceed, CEED_ERROR_UNSUPPORTED, "Backend does not support GetOffsets");
1852b730f8bSJeremy L Thompson     CeedCall(rstr->GetOffsets(rstr, mem_type, offsets));
186d1d35e2fSjeremylt     rstr->num_readers++;
187c17ec2beSJeremy L Thompson   }
188e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
189430758c8SJeremy L Thompson }
190430758c8SJeremy L Thompson 
191430758c8SJeremy L Thompson /**
192430758c8SJeremy L Thompson   @brief Restore an offsets array obtained using CeedElemRestrictionGetOffsets()
193430758c8SJeremy L Thompson 
194ea61e9acSJeremy L Thompson   @param[in] rstr    CeedElemRestriction to restore
195ea61e9acSJeremy L Thompson   @param[in] offsets Array of offset data
196430758c8SJeremy L Thompson 
197430758c8SJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
198430758c8SJeremy L Thompson 
199430758c8SJeremy L Thompson   @ref User
200430758c8SJeremy L Thompson **/
2012b730f8bSJeremy L Thompson int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, const CeedInt **offsets) {
2027c1dbaffSSebastian Grimberg   if (rstr->rstr_base) {
2037c1dbaffSSebastian Grimberg     CeedCall(CeedElemRestrictionRestoreOffsets(rstr->rstr_base, offsets));
204c17ec2beSJeremy L Thompson   } else {
205430758c8SJeremy L Thompson     *offsets = NULL;
206d1d35e2fSjeremylt     rstr->num_readers--;
207c17ec2beSJeremy L Thompson   }
208e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
209bd33150aSjeremylt }
210bd33150aSjeremylt 
211bd33150aSjeremylt /**
21277d1c127SSebastian Grimberg   @brief Get read-only access to a CeedElemRestriction orientations array by memtype
2133ac43b2cSJeremy L Thompson 
21477d1c127SSebastian Grimberg   @param[in]  rstr     CeedElemRestriction to retrieve orientations
215fcbe8c06SSebastian Grimberg   @param[in]  mem_type Memory type on which to access the array.
216fcbe8c06SSebastian Grimberg                          If the backend uses a different memory type, this will perform a copy (possibly cached).
21777d1c127SSebastian Grimberg   @param[out] orients  Array on memory type mem_type
2183ac43b2cSJeremy L Thompson 
2193ac43b2cSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
2203ac43b2cSJeremy L Thompson 
22177d1c127SSebastian Grimberg   @ref User
2223ac43b2cSJeremy L Thompson **/
22377d1c127SSebastian Grimberg int CeedElemRestrictionGetOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const bool **orients) {
224fcbe8c06SSebastian Grimberg   CeedCheck(rstr->GetOrientations, rstr->ceed, CEED_ERROR_UNSUPPORTED, "Backend does not support GetOrientations");
22577d1c127SSebastian Grimberg   CeedCall(rstr->GetOrientations(rstr, mem_type, orients));
22677d1c127SSebastian Grimberg   rstr->num_readers++;
227e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2283ac43b2cSJeremy L Thompson }
2293ac43b2cSJeremy L Thompson 
2303ac43b2cSJeremy L Thompson /**
23177d1c127SSebastian Grimberg   @brief Restore an orientations array obtained using CeedElemRestrictionGetOrientations()
232b435c5a6Srezgarshakeri 
23377d1c127SSebastian Grimberg   @param[in] rstr    CeedElemRestriction to restore
23477d1c127SSebastian Grimberg   @param[in] orients Array of orientation data
235b435c5a6Srezgarshakeri 
236b435c5a6Srezgarshakeri   @return An error code: 0 - success, otherwise - failure
237b435c5a6Srezgarshakeri 
23877d1c127SSebastian Grimberg   @ref User
239b435c5a6Srezgarshakeri **/
24077d1c127SSebastian Grimberg int CeedElemRestrictionRestoreOrientations(CeedElemRestriction rstr, const bool **orients) {
24177d1c127SSebastian Grimberg   *orients = NULL;
24277d1c127SSebastian Grimberg   rstr->num_readers--;
243b435c5a6Srezgarshakeri   return CEED_ERROR_SUCCESS;
244b435c5a6Srezgarshakeri }
245b435c5a6Srezgarshakeri 
246b435c5a6Srezgarshakeri /**
24777d1c127SSebastian Grimberg   @brief Get read-only access to a CeedElemRestriction curl-conforming orientations array by memtype
2487a982d89SJeremy L. Thompson 
24977d1c127SSebastian Grimberg   @param[in]  rstr         CeedElemRestriction to retrieve curl-conforming orientations
250fcbe8c06SSebastian Grimberg   @param[in]  mem_type     Memory type on which to access the array.
251fcbe8c06SSebastian Grimberg                              If the backend uses a different memory type, this will perform a copy (possibly cached).
25277d1c127SSebastian Grimberg   @param[out] curl_orients Array on memory type mem_type
2537a982d89SJeremy L. Thompson 
2547a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
2557a982d89SJeremy L. Thompson 
25677d1c127SSebastian Grimberg   @ref User
2577a982d89SJeremy L. Thompson **/
2580c73c039SSebastian Grimberg int CeedElemRestrictionGetCurlOrientations(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt8 **curl_orients) {
259fcbe8c06SSebastian Grimberg   CeedCheck(rstr->GetCurlOrientations, rstr->ceed, CEED_ERROR_UNSUPPORTED, "Backend does not support GetCurlOrientations");
26077d1c127SSebastian Grimberg   CeedCall(rstr->GetCurlOrientations(rstr, mem_type, curl_orients));
26177d1c127SSebastian Grimberg   rstr->num_readers++;
26277d1c127SSebastian Grimberg   return CEED_ERROR_SUCCESS;
26377d1c127SSebastian Grimberg }
26477d1c127SSebastian Grimberg 
26577d1c127SSebastian Grimberg /**
26677d1c127SSebastian Grimberg   @brief Restore an orientations array obtained using CeedElemRestrictionGetCurlOrientations()
26777d1c127SSebastian Grimberg 
26877d1c127SSebastian Grimberg   @param[in] rstr         CeedElemRestriction to restore
26977d1c127SSebastian Grimberg   @param[in] curl_orients Array of orientation data
27077d1c127SSebastian Grimberg 
27177d1c127SSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
27277d1c127SSebastian Grimberg 
27377d1c127SSebastian Grimberg   @ref User
27477d1c127SSebastian Grimberg **/
2750c73c039SSebastian Grimberg int CeedElemRestrictionRestoreCurlOrientations(CeedElemRestriction rstr, const CeedInt8 **curl_orients) {
27677d1c127SSebastian Grimberg   *curl_orients = NULL;
27777d1c127SSebastian Grimberg   rstr->num_readers--;
278e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
2797a982d89SJeremy L. Thompson }
2807a982d89SJeremy L. Thompson 
2817a982d89SJeremy L. Thompson /**
28249fd234cSJeremy L Thompson 
28349fd234cSJeremy L Thompson   @brief Get the E-vector layout of a CeedElemRestriction
28449fd234cSJeremy L Thompson 
285ea61e9acSJeremy L Thompson   @param[in]  rstr    CeedElemRestriction
286fcbe8c06SSebastian Grimberg   @param[out] layout  Variable to store layout array, stored as [nodes, components, elements].
287fcbe8c06SSebastian Grimberg                         The data for node i, component j, element k in the E-vector is given by i*layout[0] + j*layout[1] + k*layout[2]
28849fd234cSJeremy L Thompson 
28949fd234cSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
29049fd234cSJeremy L Thompson 
29149fd234cSJeremy L Thompson   @ref Backend
29249fd234cSJeremy L Thompson **/
2932b730f8bSJeremy L Thompson int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, CeedInt (*layout)[3]) {
2946574a04fSJeremy L Thompson   CeedCheck(rstr->layout[0], rstr->ceed, CEED_ERROR_MINOR, "ElemRestriction has no layout data");
2952b730f8bSJeremy L Thompson   for (CeedInt i = 0; i < 3; i++) (*layout)[i] = rstr->layout[i];
296e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
29749fd234cSJeremy L Thompson }
29849fd234cSJeremy L Thompson 
29949fd234cSJeremy L Thompson /**
30049fd234cSJeremy L Thompson 
30149fd234cSJeremy L Thompson   @brief Set the E-vector layout of a CeedElemRestriction
30249fd234cSJeremy L Thompson 
303ea61e9acSJeremy L Thompson   @param[in] rstr   CeedElemRestriction
304ea61e9acSJeremy L Thompson   @param[in] layout Variable to containing layout array, stored as [nodes, components, elements].
305ea61e9acSJeremy L Thompson                       The data for node i, component j, element k in the E-vector is given by i*layout[0] + j*layout[1] + k*layout[2]
30649fd234cSJeremy L Thompson 
30749fd234cSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
30849fd234cSJeremy L Thompson 
30949fd234cSJeremy L Thompson   @ref Backend
31049fd234cSJeremy L Thompson **/
3112b730f8bSJeremy L Thompson int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, CeedInt layout[3]) {
3122b730f8bSJeremy L Thompson   for (CeedInt i = 0; i < 3; i++) rstr->layout[i] = layout[i];
313e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
31449fd234cSJeremy L Thompson }
31549fd234cSJeremy L Thompson 
31649fd234cSJeremy L Thompson /**
3177a982d89SJeremy L. Thompson   @brief Get the backend data of a CeedElemRestriction
3187a982d89SJeremy L. Thompson 
319ea61e9acSJeremy L Thompson   @param[in]  rstr CeedElemRestriction
3207a982d89SJeremy L. Thompson   @param[out] data Variable to store data
3217a982d89SJeremy L. Thompson 
3227a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3237a982d89SJeremy L. Thompson 
3247a982d89SJeremy L. Thompson   @ref Backend
3257a982d89SJeremy L. Thompson **/
326777ff853SJeremy L Thompson int CeedElemRestrictionGetData(CeedElemRestriction rstr, void *data) {
327777ff853SJeremy L Thompson   *(void **)data = rstr->data;
328e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3297a982d89SJeremy L. Thompson }
3307a982d89SJeremy L. Thompson 
3317a982d89SJeremy L. Thompson /**
3327a982d89SJeremy L. Thompson   @brief Set the backend data of a CeedElemRestriction
3337a982d89SJeremy L. Thompson 
334ea61e9acSJeremy L Thompson   @param[in,out] rstr CeedElemRestriction
335ea61e9acSJeremy L Thompson   @param[in]     data Data to set
3367a982d89SJeremy L. Thompson 
3377a982d89SJeremy L. Thompson   @return An error code: 0 - success, otherwise - failure
3387a982d89SJeremy L. Thompson 
3397a982d89SJeremy L. Thompson   @ref Backend
3407a982d89SJeremy L. Thompson **/
341777ff853SJeremy L Thompson int CeedElemRestrictionSetData(CeedElemRestriction rstr, void *data) {
342777ff853SJeremy L Thompson   rstr->data = data;
343e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
3447a982d89SJeremy L. Thompson }
3457a982d89SJeremy L. Thompson 
34634359f16Sjeremylt /**
34734359f16Sjeremylt   @brief Increment the reference counter for a CeedElemRestriction
34834359f16Sjeremylt 
349ea61e9acSJeremy L Thompson   @param[in,out] rstr ElemRestriction to increment the reference counter
35034359f16Sjeremylt 
35134359f16Sjeremylt   @return An error code: 0 - success, otherwise - failure
35234359f16Sjeremylt 
35334359f16Sjeremylt   @ref Backend
35434359f16Sjeremylt **/
3559560d06aSjeremylt int CeedElemRestrictionReference(CeedElemRestriction rstr) {
35634359f16Sjeremylt   rstr->ref_count++;
35734359f16Sjeremylt   return CEED_ERROR_SUCCESS;
35834359f16Sjeremylt }
35934359f16Sjeremylt 
3606e15d496SJeremy L Thompson /**
3616e15d496SJeremy L Thompson   @brief Estimate number of FLOPs required to apply CeedElemRestriction in t_mode
3626e15d496SJeremy L Thompson 
363ea61e9acSJeremy L Thompson   @param[in]  rstr   ElemRestriction to estimate FLOPs for
364ea61e9acSJeremy L Thompson   @param[in]  t_mode Apply restriction or transpose
365ea61e9acSJeremy L Thompson   @param[out] flops  Address of variable to hold FLOPs estimate
3666e15d496SJeremy L Thompson 
3676e15d496SJeremy L Thompson   @ref Backend
3686e15d496SJeremy L Thompson **/
3692b730f8bSJeremy L Thompson int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops) {
370e7f679fcSJeremy L Thompson   CeedInt             e_size = rstr->num_block * rstr->block_size * rstr->elem_size * rstr->num_comp, scale = 0;
37189edb9e3SSebastian Grimberg   CeedRestrictionType rstr_type;
372*1c66c397SJeremy L Thompson 
37389edb9e3SSebastian Grimberg   CeedCall(CeedElemRestrictionGetType(rstr, &rstr_type));
37477d1c127SSebastian Grimberg   if (t_mode == CEED_TRANSPOSE) {
37589edb9e3SSebastian Grimberg     switch (rstr_type) {
37689edb9e3SSebastian Grimberg       case CEED_RESTRICTION_STRIDED:
37789edb9e3SSebastian Grimberg       case CEED_RESTRICTION_STANDARD:
37877d1c127SSebastian Grimberg         scale = 1;
37989edb9e3SSebastian Grimberg         break;
38089edb9e3SSebastian Grimberg       case CEED_RESTRICTION_ORIENTED:
38177d1c127SSebastian Grimberg         scale = 2;
38289edb9e3SSebastian Grimberg         break;
38389edb9e3SSebastian Grimberg       case CEED_RESTRICTION_CURL_ORIENTED:
38477d1c127SSebastian Grimberg         scale = 6;
38589edb9e3SSebastian Grimberg         break;
3866e15d496SJeremy L Thompson     }
38777d1c127SSebastian Grimberg   } else {
38889edb9e3SSebastian Grimberg     switch (rstr_type) {
38989edb9e3SSebastian Grimberg       case CEED_RESTRICTION_STRIDED:
39089edb9e3SSebastian Grimberg       case CEED_RESTRICTION_STANDARD:
39177d1c127SSebastian Grimberg         scale = 0;
39289edb9e3SSebastian Grimberg         break;
39389edb9e3SSebastian Grimberg       case CEED_RESTRICTION_ORIENTED:
39477d1c127SSebastian Grimberg         scale = 1;
39589edb9e3SSebastian Grimberg         break;
39689edb9e3SSebastian Grimberg       case CEED_RESTRICTION_CURL_ORIENTED:
39777d1c127SSebastian Grimberg         scale = 5;
39889edb9e3SSebastian Grimberg         break;
39977d1c127SSebastian Grimberg     }
40077d1c127SSebastian Grimberg   }
4016e15d496SJeremy L Thompson   *flops = e_size * scale;
4026e15d496SJeremy L Thompson   return CEED_ERROR_SUCCESS;
4036e15d496SJeremy L Thompson }
4046e15d496SJeremy L Thompson 
4057a982d89SJeremy L. Thompson /// @}
4067a982d89SJeremy L. Thompson 
40715910d16Sjeremylt /// @cond DOXYGEN_SKIP
40815910d16Sjeremylt static struct CeedElemRestriction_private ceed_elemrestriction_none;
40915910d16Sjeremylt /// @endcond
41015910d16Sjeremylt 
4117a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
4127a982d89SJeremy L. Thompson /// CeedElemRestriction Public API
4137a982d89SJeremy L. Thompson /// ----------------------------------------------------------------------------
4147a982d89SJeremy L. Thompson /// @addtogroup CeedElemRestrictionUser
415d7b241e6Sjeremylt /// @{
416d7b241e6Sjeremylt 
4177a982d89SJeremy L. Thompson /// Indicate that the stride is determined by the backend
41845f1e315Sjeremylt const CeedInt CEED_STRIDES_BACKEND[3] = {0};
4197a982d89SJeremy L. Thompson 
4204cc79fe7SJed Brown /// Indicate that no CeedElemRestriction is provided by the user
4212b730f8bSJeremy L Thompson const CeedElemRestriction CEED_ELEMRESTRICTION_NONE = &ceed_elemrestriction_none;
4227a982d89SJeremy L. Thompson 
423d7b241e6Sjeremylt /**
424b11c1e72Sjeremylt   @brief Create a CeedElemRestriction
425d7b241e6Sjeremylt 
426ea61e9acSJeremy L Thompson   @param[in]  ceed        Ceed object where the CeedElemRestriction will be created
427ea61e9acSJeremy L Thompson   @param[in]  num_elem    Number of elements described in the @a offsets array
428ea61e9acSJeremy L Thompson   @param[in]  elem_size   Size (number of "nodes") per element
429ea61e9acSJeremy L Thompson   @param[in]  num_comp    Number of field components per interpolation node (1 for scalar fields)
430fcbe8c06SSebastian Grimberg   @param[in]  comp_stride Stride between components for the same L-vector "node".
431fcbe8c06SSebastian Grimberg                             Data for node i, component j, element k can be found in the L-vector at index offsets[i + k*elem_size] + j*comp_stride.
432fcbe8c06SSebastian Grimberg   @param[in]  l_size      The size of the L-vector.
433fcbe8c06SSebastian Grimberg                             This vector may be larger than the elements and fields given by this restriction.
434ea61e9acSJeremy L Thompson   @param[in]  mem_type    Memory type of the @a offsets array, see CeedMemType
435ea61e9acSJeremy L Thompson   @param[in]  copy_mode   Copy mode for the @a offsets array, see CeedCopyMode
436fcbe8c06SSebastian Grimberg   @param[in]  offsets     Array of shape [@a num_elem, @a elem_size].
437fcbe8c06SSebastian Grimberg                             Row i holds the ordered list of the offsets (into the input CeedVector) for the unknowns corresponding to element i, where
438fcbe8c06SSebastian Grimberg 0 <= i < @a num_elem. All offsets must be in the range [0, @a l_size - 1].
439ea61e9acSJeremy L Thompson   @param[out] rstr        Address of the variable where the newly created CeedElemRestriction will be stored
440d7b241e6Sjeremylt 
441b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
442dfdf5a53Sjeremylt 
4437a982d89SJeremy L. Thompson   @ref User
444b11c1e72Sjeremylt **/
4452b730f8bSJeremy L Thompson int CeedElemRestrictionCreate(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size,
4462b730f8bSJeremy L Thompson                               CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, CeedElemRestriction *rstr) {
4475fe0d4faSjeremylt   if (!ceed->ElemRestrictionCreate) {
4485fe0d4faSjeremylt     Ceed delegate;
4496574a04fSJeremy L Thompson 
4502b730f8bSJeremy L Thompson     CeedCall(CeedGetObjectDelegate(ceed, &delegate, "ElemRestriction"));
45177d1c127SSebastian Grimberg     CeedCheck(delegate, ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionCreate");
4522b730f8bSJeremy L Thompson     CeedCall(CeedElemRestrictionCreate(delegate, num_elem, elem_size, num_comp, comp_stride, l_size, mem_type, copy_mode, offsets, rstr));
453e15f9bd0SJeremy L Thompson     return CEED_ERROR_SUCCESS;
4545fe0d4faSjeremylt   }
4555fe0d4faSjeremylt 
456e7f679fcSJeremy L Thompson   CeedCheck(num_elem >= 0, ceed, CEED_ERROR_DIMENSION, "Number of elements must be non-negative");
4576574a04fSJeremy L Thompson   CeedCheck(elem_size > 0, ceed, CEED_ERROR_DIMENSION, "Element size must be at least 1");
4586574a04fSJeremy L Thompson   CeedCheck(num_comp > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction must have at least 1 component");
4596574a04fSJeremy L Thompson   CeedCheck(num_comp == 1 || comp_stride > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction component stride must be at least 1");
460e022e1f8SJeremy L Thompson 
4612b730f8bSJeremy L Thompson   CeedCall(CeedCalloc(1, rstr));
462db002c03SJeremy L Thompson   CeedCall(CeedReferenceCopy(ceed, &(*rstr)->ceed));
463d1d35e2fSjeremylt   (*rstr)->ref_count   = 1;
464d1d35e2fSjeremylt   (*rstr)->num_elem    = num_elem;
465d1d35e2fSjeremylt   (*rstr)->elem_size   = elem_size;
466d1d35e2fSjeremylt   (*rstr)->num_comp    = num_comp;
467d1d35e2fSjeremylt   (*rstr)->comp_stride = comp_stride;
468d1d35e2fSjeremylt   (*rstr)->l_size      = l_size;
469e7f679fcSJeremy L Thompson   (*rstr)->num_block   = num_elem;
470e7f679fcSJeremy L Thompson   (*rstr)->block_size  = 1;
47161a27d74SSebastian Grimberg   (*rstr)->rstr_type   = CEED_RESTRICTION_STANDARD;
472fcbe8c06SSebastian Grimberg   CeedCall(ceed->ElemRestrictionCreate(mem_type, copy_mode, offsets, NULL, NULL, *rstr));
473e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
474d7b241e6Sjeremylt }
475d7b241e6Sjeremylt 
476d7b241e6Sjeremylt /**
47777d1c127SSebastian Grimberg   @brief Create a CeedElemRestriction with orientation signs
478fc0567d9Srezgarshakeri 
479ea61e9acSJeremy L Thompson   @param[in]  ceed        Ceed object where the CeedElemRestriction will be created
480ea61e9acSJeremy L Thompson   @param[in]  num_elem    Number of elements described in the @a offsets array
481ea61e9acSJeremy L Thompson   @param[in]  elem_size   Size (number of "nodes") per element
482ea61e9acSJeremy L Thompson   @param[in]  num_comp    Number of field components per interpolation node (1 for scalar fields)
483fcbe8c06SSebastian Grimberg   @param[in]  comp_stride Stride between components for the same L-vector "node".
484fcbe8c06SSebastian Grimberg                             Data for node i, component j, element k can be found in the L-vector at index offsets[i + k*elem_size] + j*comp_stride.
485fcbe8c06SSebastian Grimberg   @param[in]  l_size      The size of the L-vector.
486fcbe8c06SSebastian Grimberg                             This vector may be larger than the elements and fields given by this restriction.
487ea61e9acSJeremy L Thompson   @param[in]  mem_type    Memory type of the @a offsets array, see CeedMemType
488ea61e9acSJeremy L Thompson   @param[in]  copy_mode   Copy mode for the @a offsets array, see CeedCopyMode
489fcbe8c06SSebastian Grimberg   @param[in]  offsets     Array of shape [@a num_elem, @a elem_size].
490fcbe8c06SSebastian Grimberg                             Row i holds the ordered list of the offsets (into the input CeedVector) for the unknowns corresponding to element i, where
491fcbe8c06SSebastian Grimberg 0 <= i < @a num_elem. All offsets must be in the range [0, @a l_size - 1].
49277d1c127SSebastian Grimberg   @param[in]  orients     Array of shape [@a num_elem, @a elem_size] with bool false for positively oriented and true to flip the orientation.
493ea61e9acSJeremy L Thompson   @param[out] rstr        Address of the variable where the newly created CeedElemRestriction will be stored
494fc0567d9Srezgarshakeri 
495fc0567d9Srezgarshakeri   @return An error code: 0 - success, otherwise - failure
496fc0567d9Srezgarshakeri 
497fc0567d9Srezgarshakeri   @ref User
498fc0567d9Srezgarshakeri **/
4992b730f8bSJeremy L Thompson int CeedElemRestrictionCreateOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size,
50077d1c127SSebastian Grimberg                                       CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, const bool *orients,
501fc0567d9Srezgarshakeri                                       CeedElemRestriction *rstr) {
502fcbe8c06SSebastian Grimberg   if (!ceed->ElemRestrictionCreate) {
503fc0567d9Srezgarshakeri     Ceed delegate;
5046574a04fSJeremy L Thompson 
5052b730f8bSJeremy L Thompson     CeedCall(CeedGetObjectDelegate(ceed, &delegate, "ElemRestriction"));
506fcbe8c06SSebastian Grimberg     CeedCheck(delegate, ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionCreate");
5072b730f8bSJeremy L Thompson     CeedCall(
50877d1c127SSebastian Grimberg         CeedElemRestrictionCreateOriented(delegate, num_elem, elem_size, num_comp, comp_stride, l_size, mem_type, copy_mode, offsets, orients, rstr));
509fc0567d9Srezgarshakeri     return CEED_ERROR_SUCCESS;
510fc0567d9Srezgarshakeri   }
511fc0567d9Srezgarshakeri 
512e7f679fcSJeremy L Thompson   CeedCheck(num_elem >= 0, ceed, CEED_ERROR_DIMENSION, "Number of elements must be non-negative");
5136574a04fSJeremy L Thompson   CeedCheck(elem_size > 0, ceed, CEED_ERROR_DIMENSION, "Element size must be at least 1");
5146574a04fSJeremy L Thompson   CeedCheck(num_comp > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction must have at least 1 component");
5156574a04fSJeremy L Thompson   CeedCheck(num_comp == 1 || comp_stride > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction component stride must be at least 1");
516e022e1f8SJeremy L Thompson 
5172b730f8bSJeremy L Thompson   CeedCall(CeedCalloc(1, rstr));
518db002c03SJeremy L Thompson   CeedCall(CeedReferenceCopy(ceed, &(*rstr)->ceed));
519fc0567d9Srezgarshakeri   (*rstr)->ref_count   = 1;
520fc0567d9Srezgarshakeri   (*rstr)->num_elem    = num_elem;
521fc0567d9Srezgarshakeri   (*rstr)->elem_size   = elem_size;
522fc0567d9Srezgarshakeri   (*rstr)->num_comp    = num_comp;
523fc0567d9Srezgarshakeri   (*rstr)->comp_stride = comp_stride;
524fc0567d9Srezgarshakeri   (*rstr)->l_size      = l_size;
525e7f679fcSJeremy L Thompson   (*rstr)->num_block   = num_elem;
526e7f679fcSJeremy L Thompson   (*rstr)->block_size  = 1;
527fcbe8c06SSebastian Grimberg   (*rstr)->rstr_type   = CEED_RESTRICTION_ORIENTED;
528fcbe8c06SSebastian Grimberg   CeedCall(ceed->ElemRestrictionCreate(mem_type, copy_mode, offsets, orients, NULL, *rstr));
52977d1c127SSebastian Grimberg   return CEED_ERROR_SUCCESS;
53077d1c127SSebastian Grimberg }
53177d1c127SSebastian Grimberg 
53277d1c127SSebastian Grimberg /**
53377d1c127SSebastian Grimberg   @brief Create a CeedElemRestriction with a general tridiagonal transformation matrix for curl-conforming elements
53477d1c127SSebastian Grimberg 
53577d1c127SSebastian Grimberg   @param[in]  ceed         Ceed object where the CeedElemRestriction will be created
53677d1c127SSebastian Grimberg   @param[in]  num_elem     Number of elements described in the @a offsets array
53777d1c127SSebastian Grimberg   @param[in]  elem_size    Size (number of "nodes") per element
53877d1c127SSebastian Grimberg   @param[in]  num_comp     Number of field components per interpolation node (1 for scalar fields)
539fcbe8c06SSebastian Grimberg   @param[in]  comp_stride  Stride between components for the same L-vector "node".
540fcbe8c06SSebastian Grimberg                              Data for node i, component j, element k can be found in the L-vector at index offsets[i + k*elem_size] + j*comp_stride.
541fcbe8c06SSebastian Grimberg   @param[in]  l_size       The size of the L-vector.
542fcbe8c06SSebastian Grimberg                              This vector may be larger than the elements and fields given by this restriction.
54377d1c127SSebastian Grimberg   @param[in]  mem_type     Memory type of the @a offsets array, see CeedMemType
54477d1c127SSebastian Grimberg   @param[in]  copy_mode    Copy mode for the @a offsets array, see CeedCopyMode
545fcbe8c06SSebastian Grimberg   @param[in]  offsets      Array of shape [@a num_elem, @a elem_size].
546fcbe8c06SSebastian Grimberg                              Row i holds the ordered list of the offsets (into the input CeedVector) for the unknowns corresponding to element i,
547fcbe8c06SSebastian Grimberg where 0 <= i < @a num_elem. All offsets must be in the range [0, @a l_size - 1].
5487c1dbaffSSebastian Grimberg   @param[in]  curl_orients Array of shape [@a num_elem, @a 3 * elem_size] representing a row-major tridiagonal matrix (curl_orients[i * 3 * elem_size]
5497c1dbaffSSebastian Grimberg = curl_orients[(i + 1) * 3 * elem_size - 1] = 0, where 0 <= i < @a num_elem) which is applied to the element unknowns upon restriction. This
5507c1dbaffSSebastian Grimberg orientation matrix allows for pairs of face degrees of freedom on elements for H(curl) spaces to be coupled in the element restriction operation,
5517c1dbaffSSebastian Grimberg which is a way to resolve face orientation issues for 3D meshes (https://dl.acm.org/doi/pdf/10.1145/3524456).
55277d1c127SSebastian Grimberg   @param[out] rstr         Address of the variable where the newly created CeedElemRestriction will be stored
55377d1c127SSebastian Grimberg 
55477d1c127SSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
55577d1c127SSebastian Grimberg 
55677d1c127SSebastian Grimberg   @ref User
55777d1c127SSebastian Grimberg **/
55877d1c127SSebastian Grimberg int CeedElemRestrictionCreateCurlOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedInt comp_stride, CeedSize l_size,
5590c73c039SSebastian Grimberg                                           CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets, const CeedInt8 *curl_orients,
56077d1c127SSebastian Grimberg                                           CeedElemRestriction *rstr) {
561fcbe8c06SSebastian Grimberg   if (!ceed->ElemRestrictionCreate) {
56277d1c127SSebastian Grimberg     Ceed delegate;
56377d1c127SSebastian Grimberg 
56477d1c127SSebastian Grimberg     CeedCall(CeedGetObjectDelegate(ceed, &delegate, "ElemRestriction"));
565fcbe8c06SSebastian Grimberg     CeedCheck(delegate, ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionCreate");
56677d1c127SSebastian Grimberg     CeedCall(CeedElemRestrictionCreateCurlOriented(delegate, num_elem, elem_size, num_comp, comp_stride, l_size, mem_type, copy_mode, offsets,
56777d1c127SSebastian Grimberg                                                    curl_orients, rstr));
56877d1c127SSebastian Grimberg     return CEED_ERROR_SUCCESS;
56977d1c127SSebastian Grimberg   }
57077d1c127SSebastian Grimberg 
571e7f679fcSJeremy L Thompson   CeedCheck(num_elem >= 0, ceed, CEED_ERROR_DIMENSION, "Number of elements must be non-negative");
57277d1c127SSebastian Grimberg   CeedCheck(elem_size > 0, ceed, CEED_ERROR_DIMENSION, "Element size must be at least 1");
57377d1c127SSebastian Grimberg   CeedCheck(num_comp > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction must have at least 1 component");
57477d1c127SSebastian Grimberg   CeedCheck(num_comp == 1 || comp_stride > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction component stride must be at least 1");
57577d1c127SSebastian Grimberg 
57677d1c127SSebastian Grimberg   CeedCall(CeedCalloc(1, rstr));
577fcbe8c06SSebastian Grimberg   CeedCall(CeedReferenceCopy(ceed, &(*rstr)->ceed));
57877d1c127SSebastian Grimberg   (*rstr)->ref_count   = 1;
57977d1c127SSebastian Grimberg   (*rstr)->num_elem    = num_elem;
58077d1c127SSebastian Grimberg   (*rstr)->elem_size   = elem_size;
58177d1c127SSebastian Grimberg   (*rstr)->num_comp    = num_comp;
58277d1c127SSebastian Grimberg   (*rstr)->comp_stride = comp_stride;
58377d1c127SSebastian Grimberg   (*rstr)->l_size      = l_size;
584e7f679fcSJeremy L Thompson   (*rstr)->num_block   = num_elem;
585e7f679fcSJeremy L Thompson   (*rstr)->block_size  = 1;
586fcbe8c06SSebastian Grimberg   (*rstr)->rstr_type   = CEED_RESTRICTION_CURL_ORIENTED;
587fcbe8c06SSebastian Grimberg   CeedCall(ceed->ElemRestrictionCreate(mem_type, copy_mode, offsets, NULL, curl_orients, *rstr));
588fc0567d9Srezgarshakeri   return CEED_ERROR_SUCCESS;
589fc0567d9Srezgarshakeri }
590fc0567d9Srezgarshakeri 
591fc0567d9Srezgarshakeri /**
5927509a596Sjeremylt   @brief Create a strided CeedElemRestriction
593d7b241e6Sjeremylt 
594ea61e9acSJeremy L Thompson   @param[in]  ceed      Ceed object where the CeedElemRestriction will be created
595ea61e9acSJeremy L Thompson   @param[in]  num_elem  Number of elements described by the restriction
596ea61e9acSJeremy L Thompson   @param[in]  elem_size Size (number of "nodes") per element
597ea61e9acSJeremy L Thompson   @param[in]  num_comp  Number of field components per interpolation "node" (1 for scalar fields)
598fcbe8c06SSebastian Grimberg   @param[in]  l_size    The size of the L-vector.
599fcbe8c06SSebastian Grimberg                           This vector may be larger than the elements and fields given by this restriction.
600fcbe8c06SSebastian Grimberg   @param[in]  strides   Array for strides between [nodes, components, elements].
601fcbe8c06SSebastian Grimberg                           Data for node i, component j, element k can be found in the L-vector at index i*strides[0] + j*strides[1] + k*strides[2].
602fcbe8c06SSebastian Grimberg                           @a CEED_STRIDES_BACKEND may be used with vectors created by a Ceed backend.
603ea61e9acSJeremy L Thompson   @param[out] rstr      Address of the variable where the newly created CeedElemRestriction will be stored
604d7b241e6Sjeremylt 
605b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
606dfdf5a53Sjeremylt 
6077a982d89SJeremy L. Thompson   @ref User
608b11c1e72Sjeremylt **/
6092b730f8bSJeremy L Thompson int CeedElemRestrictionCreateStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt num_comp, CeedSize l_size, const CeedInt strides[3],
610f90c8643Sjeremylt                                      CeedElemRestriction *rstr) {
6115fe0d4faSjeremylt   if (!ceed->ElemRestrictionCreate) {
6125fe0d4faSjeremylt     Ceed delegate;
613b04eb3d9SSebastian Grimberg 
6142b730f8bSJeremy L Thompson     CeedCall(CeedGetObjectDelegate(ceed, &delegate, "ElemRestriction"));
615fcbe8c06SSebastian Grimberg     CeedCheck(delegate, ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionCreate");
6162b730f8bSJeremy L Thompson     CeedCall(CeedElemRestrictionCreateStrided(delegate, num_elem, elem_size, num_comp, l_size, strides, rstr));
617e15f9bd0SJeremy L Thompson     return CEED_ERROR_SUCCESS;
6185fe0d4faSjeremylt   }
6195fe0d4faSjeremylt 
620e7f679fcSJeremy L Thompson   CeedCheck(num_elem >= 0, ceed, CEED_ERROR_DIMENSION, "Number of elements must be non-negative");
6216574a04fSJeremy L Thompson   CeedCheck(elem_size > 0, ceed, CEED_ERROR_DIMENSION, "Element size must be at least 1");
6226574a04fSJeremy L Thompson   CeedCheck(num_comp > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction must have at least 1 component");
623e7f679fcSJeremy L Thompson   CeedCheck(l_size >= num_elem * elem_size * num_comp, ceed, CEED_ERROR_DIMENSION, "L-vector size must be at least num_elem * elem_size * num_comp");
624e022e1f8SJeremy L Thompson 
6252b730f8bSJeremy L Thompson   CeedCall(CeedCalloc(1, rstr));
626db002c03SJeremy L Thompson   CeedCall(CeedReferenceCopy(ceed, &(*rstr)->ceed));
627d1d35e2fSjeremylt   (*rstr)->ref_count  = 1;
628d1d35e2fSjeremylt   (*rstr)->num_elem   = num_elem;
629d1d35e2fSjeremylt   (*rstr)->elem_size  = elem_size;
630d1d35e2fSjeremylt   (*rstr)->num_comp   = num_comp;
631d1d35e2fSjeremylt   (*rstr)->l_size     = l_size;
632e7f679fcSJeremy L Thompson   (*rstr)->num_block  = num_elem;
633e7f679fcSJeremy L Thompson   (*rstr)->block_size = 1;
634fcbe8c06SSebastian Grimberg   (*rstr)->rstr_type  = CEED_RESTRICTION_STRIDED;
6352b730f8bSJeremy L Thompson   CeedCall(CeedMalloc(3, &(*rstr)->strides));
6362b730f8bSJeremy L Thompson   for (CeedInt i = 0; i < 3; i++) (*rstr)->strides[i] = strides[i];
637fcbe8c06SSebastian Grimberg   CeedCall(ceed->ElemRestrictionCreate(CEED_MEM_HOST, CEED_OWN_POINTER, NULL, NULL, NULL, *rstr));
638e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
639d7b241e6Sjeremylt }
640d7b241e6Sjeremylt 
641d7b241e6Sjeremylt /**
642b11c1e72Sjeremylt   @brief Create a blocked CeedElemRestriction, typically only called by backends
643d7b241e6Sjeremylt 
644ea61e9acSJeremy L Thompson   @param[in]  ceed          Ceed object where the CeedElemRestriction will be created.
645ea61e9acSJeremy L Thompson   @param[in]  num_elem      Number of elements described in the @a offsets array.
646ea61e9acSJeremy L Thompson   @param[in]  elem_size     Size (number of unknowns) per element
647e7f679fcSJeremy L Thompson   @param[in]  block_size    Number of elements in a block
648ea61e9acSJeremy L Thompson   @param[in]  num_comp      Number of field components per interpolation node (1 for scalar fields)
649fcbe8c06SSebastian Grimberg   @param[in]  comp_stride   Stride between components for the same L-vector "node".
650fcbe8c06SSebastian Grimberg                               Data for node i, component j, element k can be found in the L-vector at index offsets[i + k*elem_size] + j*comp_stride.
651fcbe8c06SSebastian Grimberg   @param[in]  l_size        The size of the L-vector.
652fcbe8c06SSebastian Grimberg                               This vector may be larger than the elements and fields given by this restriction.
653ea61e9acSJeremy L Thompson   @param[in]  mem_type      Memory type of the @a offsets array, see CeedMemType
654ea61e9acSJeremy L Thompson   @param[in]  copy_mode     Copy mode for the @a offsets array, see CeedCopyMode
655fcbe8c06SSebastian Grimberg   @param[in]  offsets       Array of shape [@a num_elem, @a elem_size].
656e7f679fcSJeremy L Thompson                               Row i holds the ordered list of the offsets (into the input CeedVector) for the unknowns corresponding to element i,
657e7f679fcSJeremy L Thompson  where 0 <= i < @a num_elem. All offsets must be in the range [0, @a l_size - 1]. The backend will permute and pad this array to the desired ordering
658e7f679fcSJeremy L Thompson  for the blocksize, which is typically given by the backend. The default reordering is to interlace elements.
659ea61e9acSJeremy L Thompson   @param[out] rstr          Address of the variable where the newly created CeedElemRestriction will be stored
660d7b241e6Sjeremylt 
661b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
662dfdf5a53Sjeremylt 
6637a982d89SJeremy L. Thompson   @ref Backend
664b11c1e72Sjeremylt  **/
665e7f679fcSJeremy L Thompson int CeedElemRestrictionCreateBlocked(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp, CeedInt comp_stride,
6662b730f8bSJeremy L Thompson                                      CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode, const CeedInt *offsets,
6674ce2993fSjeremylt                                      CeedElemRestriction *rstr) {
668*1c66c397SJeremy L Thompson   CeedInt *block_offsets, num_block = (num_elem / block_size) + !!(num_elem % block_size);
669d7b241e6Sjeremylt 
6705fe0d4faSjeremylt   if (!ceed->ElemRestrictionCreateBlocked) {
6715fe0d4faSjeremylt     Ceed delegate;
6726574a04fSJeremy L Thompson 
6732b730f8bSJeremy L Thompson     CeedCall(CeedGetObjectDelegate(ceed, &delegate, "ElemRestriction"));
6746402da51SJeremy L Thompson     CeedCheck(delegate, ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionCreateBlocked");
675e7f679fcSJeremy L Thompson     CeedCall(CeedElemRestrictionCreateBlocked(delegate, num_elem, elem_size, block_size, num_comp, comp_stride, l_size, mem_type, copy_mode, offsets,
676e7f679fcSJeremy L Thompson                                               rstr));
677e15f9bd0SJeremy L Thompson     return CEED_ERROR_SUCCESS;
6785fe0d4faSjeremylt   }
679d7b241e6Sjeremylt 
680e7f679fcSJeremy L Thompson   CeedCheck(num_elem >= 0, ceed, CEED_ERROR_DIMENSION, "Number of elements must be non-negative");
6816574a04fSJeremy L Thompson   CeedCheck(elem_size > 0, ceed, CEED_ERROR_DIMENSION, "Element size must be at least 1");
682e7f679fcSJeremy L Thompson   CeedCheck(block_size > 0, ceed, CEED_ERROR_DIMENSION, "Block size must be at least 1");
6836574a04fSJeremy L Thompson   CeedCheck(num_comp > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction must have at least 1 component");
6846574a04fSJeremy L Thompson   CeedCheck(num_comp == 1 || comp_stride > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction component stride must be at least 1");
685e022e1f8SJeremy L Thompson 
686e7f679fcSJeremy L Thompson   CeedCall(CeedCalloc(num_block * block_size * elem_size, &block_offsets));
687e7f679fcSJeremy L Thompson   CeedCall(CeedPermutePadOffsets(offsets, block_offsets, num_block, num_elem, block_size, elem_size));
688d7b241e6Sjeremylt 
689db002c03SJeremy L Thompson   CeedCall(CeedCalloc(1, rstr));
690db002c03SJeremy L Thompson   CeedCall(CeedReferenceCopy(ceed, &(*rstr)->ceed));
691d1d35e2fSjeremylt   (*rstr)->ref_count   = 1;
692d1d35e2fSjeremylt   (*rstr)->num_elem    = num_elem;
693d1d35e2fSjeremylt   (*rstr)->elem_size   = elem_size;
694d1d35e2fSjeremylt   (*rstr)->num_comp    = num_comp;
695d1d35e2fSjeremylt   (*rstr)->comp_stride = comp_stride;
696d1d35e2fSjeremylt   (*rstr)->l_size      = l_size;
697e7f679fcSJeremy L Thompson   (*rstr)->num_block   = num_block;
698e7f679fcSJeremy L Thompson   (*rstr)->block_size  = block_size;
69961a27d74SSebastian Grimberg   (*rstr)->rstr_type   = CEED_RESTRICTION_STANDARD;
700e7f679fcSJeremy L Thompson   CeedCall(ceed->ElemRestrictionCreateBlocked(CEED_MEM_HOST, CEED_OWN_POINTER, (const CeedInt *)block_offsets, NULL, NULL, *rstr));
701*1c66c397SJeremy L Thompson   if (copy_mode == CEED_OWN_POINTER) CeedCall(CeedFree(&offsets));
702e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
703d7b241e6Sjeremylt }
704d7b241e6Sjeremylt 
705b11c1e72Sjeremylt /**
70677d1c127SSebastian Grimberg   @brief Create a blocked oriented CeedElemRestriction, typically only called by backends
70777d1c127SSebastian Grimberg 
70877d1c127SSebastian Grimberg   @param[in]  ceed          Ceed object where the CeedElemRestriction will be created.
70977d1c127SSebastian Grimberg   @param[in]  num_elem      Number of elements described in the @a offsets array.
71077d1c127SSebastian Grimberg   @param[in]  elem_size     Size (number of unknowns) per element
711e7f679fcSJeremy L Thompson   @param[in]  block_size    Number of elements in a block
71277d1c127SSebastian Grimberg   @param[in]  num_comp      Number of field components per interpolation node (1 for scalar fields)
713fcbe8c06SSebastian Grimberg   @param[in]  comp_stride   Stride between components for the same L-vector "node".
714fcbe8c06SSebastian Grimberg                               Data for node i, component j, element k can be found in the L-vector at index offsets[i + k*elem_size] + j*comp_stride.
715fcbe8c06SSebastian Grimberg   @param[in]  l_size        The size of the L-vector.
716fcbe8c06SSebastian Grimberg                               This vector may be larger than the elements and fields given by this restriction.
71777d1c127SSebastian Grimberg   @param[in]  mem_type      Memory type of the @a offsets array, see CeedMemType
71877d1c127SSebastian Grimberg   @param[in]  copy_mode     Copy mode for the @a offsets array, see CeedCopyMode
719fcbe8c06SSebastian Grimberg   @param[in]  offsets       Array of shape [@a num_elem, @a elem_size].
720fcbe8c06SSebastian Grimberg                             Row i holds the ordered list of the offsets (into the input CeedVector) for the unknowns corresponding to element i, where
721fcbe8c06SSebastian Grimberg  0 <= i < @a num_elem. All offsets must be in the range [0, @a l_size - 1]. The backend will permute and pad this array to the desired ordering for
722fcbe8c06SSebastian Grimberg  the blocksize, which is typically given by the backend. The default reordering is to interlace elements.
723fcbe8c06SSebastian Grimberg   @param[in]  orients       Array of shape [@a num_elem, @a elem_size] with bool false for positively oriented and true to flip the orientation.
724fcbe8c06SSebastian Grimberg                               Will also be permuted and padded similarly to @a offsets.
72577d1c127SSebastian Grimberg   @param[out] rstr          Address of the variable where the newly created CeedElemRestriction will be stored
72677d1c127SSebastian Grimberg 
72777d1c127SSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
72877d1c127SSebastian Grimberg 
72977d1c127SSebastian Grimberg   @ref Backend
73077d1c127SSebastian Grimberg  **/
731e7f679fcSJeremy L Thompson int CeedElemRestrictionCreateBlockedOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp,
732e7f679fcSJeremy L Thompson                                              CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode,
733e7f679fcSJeremy L Thompson                                              const CeedInt *offsets, const bool *orients, CeedElemRestriction *rstr) {
734e7f679fcSJeremy L Thompson   bool    *block_orients;
735*1c66c397SJeremy L Thompson   CeedInt *block_offsets, num_block = (num_elem / block_size) + !!(num_elem % block_size);
73677d1c127SSebastian Grimberg 
737fcbe8c06SSebastian Grimberg   if (!ceed->ElemRestrictionCreateBlocked) {
73877d1c127SSebastian Grimberg     Ceed delegate;
73977d1c127SSebastian Grimberg 
74077d1c127SSebastian Grimberg     CeedCall(CeedGetObjectDelegate(ceed, &delegate, "ElemRestriction"));
741fcbe8c06SSebastian Grimberg     CeedCheck(delegate, ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionCreateBlocked");
742e7f679fcSJeremy L Thompson     CeedCall(CeedElemRestrictionCreateBlockedOriented(delegate, num_elem, elem_size, block_size, num_comp, comp_stride, l_size, mem_type, copy_mode,
74377d1c127SSebastian Grimberg                                                       offsets, orients, rstr));
74477d1c127SSebastian Grimberg     return CEED_ERROR_SUCCESS;
74577d1c127SSebastian Grimberg   }
74677d1c127SSebastian Grimberg 
74777d1c127SSebastian Grimberg   CeedCheck(elem_size > 0, ceed, CEED_ERROR_DIMENSION, "Element size must be at least 1");
748e7f679fcSJeremy L Thompson   CeedCheck(block_size > 0, ceed, CEED_ERROR_DIMENSION, "Block size must be at least 1");
74977d1c127SSebastian Grimberg   CeedCheck(num_comp > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction must have at least 1 component");
75077d1c127SSebastian Grimberg   CeedCheck(num_comp == 1 || comp_stride > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction component stride must be at least 1");
75177d1c127SSebastian Grimberg 
752e7f679fcSJeremy L Thompson   CeedCall(CeedCalloc(num_block * block_size * elem_size, &block_offsets));
753e7f679fcSJeremy L Thompson   CeedCall(CeedCalloc(num_block * block_size * elem_size, &block_orients));
754e7f679fcSJeremy L Thompson   CeedCall(CeedPermutePadOffsets(offsets, block_offsets, num_block, num_elem, block_size, elem_size));
755e7f679fcSJeremy L Thompson   CeedCall(CeedPermutePadOrients(orients, block_orients, num_block, num_elem, block_size, elem_size));
75677d1c127SSebastian Grimberg 
757fcbe8c06SSebastian Grimberg   CeedCall(CeedCalloc(1, rstr));
758fcbe8c06SSebastian Grimberg   CeedCall(CeedReferenceCopy(ceed, &(*rstr)->ceed));
75977d1c127SSebastian Grimberg   (*rstr)->ref_count   = 1;
76077d1c127SSebastian Grimberg   (*rstr)->num_elem    = num_elem;
76177d1c127SSebastian Grimberg   (*rstr)->elem_size   = elem_size;
76277d1c127SSebastian Grimberg   (*rstr)->num_comp    = num_comp;
76377d1c127SSebastian Grimberg   (*rstr)->comp_stride = comp_stride;
76477d1c127SSebastian Grimberg   (*rstr)->l_size      = l_size;
765e7f679fcSJeremy L Thompson   (*rstr)->num_block   = num_block;
766e7f679fcSJeremy L Thompson   (*rstr)->block_size  = block_size;
767fcbe8c06SSebastian Grimberg   (*rstr)->rstr_type   = CEED_RESTRICTION_ORIENTED;
768e7f679fcSJeremy L Thompson   CeedCall(
769e7f679fcSJeremy L Thompson       ceed->ElemRestrictionCreateBlocked(CEED_MEM_HOST, CEED_OWN_POINTER, (const CeedInt *)block_offsets, (const bool *)block_orients, NULL, *rstr));
770*1c66c397SJeremy L Thompson   if (copy_mode == CEED_OWN_POINTER) CeedCall(CeedFree(&offsets));
77177d1c127SSebastian Grimberg   return CEED_ERROR_SUCCESS;
77277d1c127SSebastian Grimberg }
77377d1c127SSebastian Grimberg 
77477d1c127SSebastian Grimberg /**
77577d1c127SSebastian Grimberg   @brief Create a blocked curl-oriented CeedElemRestriction, typically only called by backends
77677d1c127SSebastian Grimberg 
77777d1c127SSebastian Grimberg   @param[in]  ceed           Ceed object where the CeedElemRestriction will be created.
77877d1c127SSebastian Grimberg   @param[in]  num_elem       Number of elements described in the @a offsets array.
77977d1c127SSebastian Grimberg   @param[in]  elem_size      Size (number of unknowns) per element
780e7f679fcSJeremy L Thompson   @param[in]  block_size     Number of elements in a block
78177d1c127SSebastian Grimberg   @param[in]  num_comp       Number of field components per interpolation node (1 for scalar fields)
782fcbe8c06SSebastian Grimberg   @param[in]  comp_stride    Stride between components for the same L-vector "node".
783fcbe8c06SSebastian Grimberg                                Data for node i, component j, element k can be found in the L-vector at index offsets[i + k*elem_size] + j*comp_stride.
784fcbe8c06SSebastian Grimberg   @param[in]  l_size         The size of the L-vector.
785fcbe8c06SSebastian Grimberg                                This vector may be larger than the elements and fields given by this restriction.
78677d1c127SSebastian Grimberg   @param[in]  mem_type       Memory type of the @a offsets array, see CeedMemType
78777d1c127SSebastian Grimberg   @param[in]  copy_mode      Copy mode for the @a offsets array, see CeedCopyMode
788fcbe8c06SSebastian Grimberg   @param[in]  offsets        Array of shape [@a num_elem, @a elem_size].
789fcbe8c06SSebastian Grimberg                              Row i holds the ordered list of the offsets (into the input CeedVector) for the unknowns corresponding to element i,
790fcbe8c06SSebastian Grimberg where 0 <= i < @a num_elem. All offsets must be in the range [0, @a l_size - 1]. The backend will permute and pad this array to the desired ordering
791fcbe8c06SSebastian Grimberg for the blocksize, which is typically given by the backend. The default reordering is to interlace elements.
7927c1dbaffSSebastian Grimberg   @param[in]  curl_orients Array of shape [@a num_elem, @a 3 * elem_size] representing a row-major tridiagonal matrix (curl_orients[i * 3 * elem_size]
7937c1dbaffSSebastian Grimberg = curl_orients[(i + 1) * 3 * elem_size - 1] = 0, where 0 <= i < @a num_elem) which is applied to the element unknowns upon restriction. This
7947c1dbaffSSebastian Grimberg orientation matrix allows for pairs of face degrees of freedom on elements for H(curl) spaces to be coupled in the element restriction operation,
7957c1dbaffSSebastian Grimberg which is a way to resolve face orientation issues for 3D meshes (https://dl.acm.org/doi/pdf/10.1145/3524456). Will also be permuted and padded
7967c1dbaffSSebastian Grimberg similarly to @a offsets.
79777d1c127SSebastian Grimberg   @param[out] rstr           Address of the variable where the newly created CeedElemRestriction will be stored
79877d1c127SSebastian Grimberg 
79977d1c127SSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
80077d1c127SSebastian Grimberg 
80177d1c127SSebastian Grimberg   @ref Backend
80277d1c127SSebastian Grimberg  **/
803e7f679fcSJeremy L Thompson int CeedElemRestrictionCreateBlockedCurlOriented(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp,
80477d1c127SSebastian Grimberg                                                  CeedInt comp_stride, CeedSize l_size, CeedMemType mem_type, CeedCopyMode copy_mode,
8050c73c039SSebastian Grimberg                                                  const CeedInt *offsets, const CeedInt8 *curl_orients, CeedElemRestriction *rstr) {
806e7f679fcSJeremy L Thompson   CeedInt8 *block_curl_orients;
807*1c66c397SJeremy L Thompson   CeedInt  *block_offsets, num_block = (num_elem / block_size) + !!(num_elem % block_size);
80877d1c127SSebastian Grimberg 
809fcbe8c06SSebastian Grimberg   if (!ceed->ElemRestrictionCreateBlocked) {
81077d1c127SSebastian Grimberg     Ceed delegate;
81177d1c127SSebastian Grimberg 
81277d1c127SSebastian Grimberg     CeedCall(CeedGetObjectDelegate(ceed, &delegate, "ElemRestriction"));
813fcbe8c06SSebastian Grimberg     CeedCheck(delegate, ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionCreateBlocked");
814e7f679fcSJeremy L Thompson     CeedCall(CeedElemRestrictionCreateBlockedCurlOriented(delegate, num_elem, elem_size, block_size, num_comp, comp_stride, l_size, mem_type,
815e7f679fcSJeremy L Thompson                                                           copy_mode, offsets, curl_orients, rstr));
81677d1c127SSebastian Grimberg     return CEED_ERROR_SUCCESS;
81777d1c127SSebastian Grimberg   }
81877d1c127SSebastian Grimberg 
819e7f679fcSJeremy L Thompson   CeedCheck(num_elem >= 0, ceed, CEED_ERROR_DIMENSION, "Number of elements must be non-negative");
82077d1c127SSebastian Grimberg   CeedCheck(elem_size > 0, ceed, CEED_ERROR_DIMENSION, "Element size must be at least 1");
821e7f679fcSJeremy L Thompson   CeedCheck(block_size > 0, ceed, CEED_ERROR_DIMENSION, "Block size must be at least 1");
82277d1c127SSebastian Grimberg   CeedCheck(num_comp > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction must have at least 1 component");
82377d1c127SSebastian Grimberg   CeedCheck(num_comp == 1 || comp_stride > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction component stride must be at least 1");
82477d1c127SSebastian Grimberg 
825e7f679fcSJeremy L Thompson   CeedCall(CeedCalloc(num_block * block_size * elem_size, &block_offsets));
826e7f679fcSJeremy L Thompson   CeedCall(CeedCalloc(num_block * block_size * 3 * elem_size, &block_curl_orients));
827e7f679fcSJeremy L Thompson   CeedCall(CeedPermutePadOffsets(offsets, block_offsets, num_block, num_elem, block_size, elem_size));
828e7f679fcSJeremy L Thompson   CeedCall(CeedPermutePadCurlOrients(curl_orients, block_curl_orients, num_block, num_elem, block_size, 3 * elem_size));
82977d1c127SSebastian Grimberg 
830fcbe8c06SSebastian Grimberg   CeedCall(CeedCalloc(1, rstr));
831fcbe8c06SSebastian Grimberg   CeedCall(CeedReferenceCopy(ceed, &(*rstr)->ceed));
83277d1c127SSebastian Grimberg   (*rstr)->ref_count   = 1;
83377d1c127SSebastian Grimberg   (*rstr)->num_elem    = num_elem;
83477d1c127SSebastian Grimberg   (*rstr)->elem_size   = elem_size;
83577d1c127SSebastian Grimberg   (*rstr)->num_comp    = num_comp;
83677d1c127SSebastian Grimberg   (*rstr)->comp_stride = comp_stride;
83777d1c127SSebastian Grimberg   (*rstr)->l_size      = l_size;
838e7f679fcSJeremy L Thompson   (*rstr)->num_block   = num_block;
839e7f679fcSJeremy L Thompson   (*rstr)->block_size  = block_size;
840fcbe8c06SSebastian Grimberg   (*rstr)->rstr_type   = CEED_RESTRICTION_CURL_ORIENTED;
841e7f679fcSJeremy L Thompson   CeedCall(ceed->ElemRestrictionCreateBlocked(CEED_MEM_HOST, CEED_OWN_POINTER, (const CeedInt *)block_offsets, NULL,
842e7f679fcSJeremy L Thompson                                               (const CeedInt8 *)block_curl_orients, *rstr));
843*1c66c397SJeremy L Thompson   if (copy_mode == CEED_OWN_POINTER) CeedCall(CeedFree(&offsets));
84477d1c127SSebastian Grimberg   return CEED_ERROR_SUCCESS;
84577d1c127SSebastian Grimberg }
84677d1c127SSebastian Grimberg 
84777d1c127SSebastian Grimberg /**
84877d1c127SSebastian Grimberg   @brief Create a blocked strided CeedElemRestriction, typically only called by backends
8497509a596Sjeremylt 
850ea61e9acSJeremy L Thompson   @param[in]  ceed        Ceed object where the CeedElemRestriction will be created
851ea61e9acSJeremy L Thompson   @param[in]  num_elem    Number of elements described by the restriction
852ea61e9acSJeremy L Thompson   @param[in]  elem_size   Size (number of "nodes") per element
853e7f679fcSJeremy L Thompson   @param[in]  block_size  Number of elements in a block
854ea61e9acSJeremy L Thompson   @param[in]  num_comp    Number of field components per interpolation node (1 for scalar fields)
855fcbe8c06SSebastian Grimberg   @param[in]  l_size      The size of the L-vector.
856fcbe8c06SSebastian Grimberg                             This vector may be larger than the elements and fields given by this restriction.
857fcbe8c06SSebastian Grimberg   @param[in]  strides     Array for strides between [nodes, components, elements].
858fcbe8c06SSebastian Grimberg                             Data for node i, component j, element k can be found in the L-vector at index i*strides[0] + j*strides[1] + k*strides[2].
859fcbe8c06SSebastian Grimberg                             @a CEED_STRIDES_BACKEND may be used with vectors created by a Ceed backend.
860ea61e9acSJeremy L Thompson   @param[out] rstr        Address of the variable where the newly created CeedElemRestriction will be stored
8617509a596Sjeremylt 
8627509a596Sjeremylt   @return An error code: 0 - success, otherwise - failure
8637509a596Sjeremylt 
8647a982d89SJeremy L. Thompson   @ref User
8657509a596Sjeremylt **/
866e7f679fcSJeremy L Thompson int CeedElemRestrictionCreateBlockedStrided(Ceed ceed, CeedInt num_elem, CeedInt elem_size, CeedInt block_size, CeedInt num_comp, CeedSize l_size,
8678621c6c6SJeremy L Thompson                                             const CeedInt strides[3], CeedElemRestriction *rstr) {
868e7f679fcSJeremy L Thompson   CeedInt num_block = (num_elem / block_size) + !!(num_elem % block_size);
8697509a596Sjeremylt 
8707509a596Sjeremylt   if (!ceed->ElemRestrictionCreateBlocked) {
8717509a596Sjeremylt     Ceed delegate;
8726574a04fSJeremy L Thompson 
8732b730f8bSJeremy L Thompson     CeedCall(CeedGetObjectDelegate(ceed, &delegate, "ElemRestriction"));
874fcbe8c06SSebastian Grimberg     CeedCheck(delegate, ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionCreateBlocked");
875e7f679fcSJeremy L Thompson     CeedCall(CeedElemRestrictionCreateBlockedStrided(delegate, num_elem, elem_size, block_size, num_comp, l_size, strides, rstr));
876e15f9bd0SJeremy L Thompson     return CEED_ERROR_SUCCESS;
8777509a596Sjeremylt   }
8787509a596Sjeremylt 
879e7f679fcSJeremy L Thompson   CeedCheck(num_elem >= 0, ceed, CEED_ERROR_DIMENSION, "Number of elements must be non-negative");
8806574a04fSJeremy L Thompson   CeedCheck(elem_size > 0, ceed, CEED_ERROR_DIMENSION, "Element size must be at least 1");
881e7f679fcSJeremy L Thompson   CeedCheck(block_size > 0, ceed, CEED_ERROR_DIMENSION, "Block size must be at least 1");
8826574a04fSJeremy L Thompson   CeedCheck(num_comp > 0, ceed, CEED_ERROR_DIMENSION, "ElemRestriction must have at least 1 component");
883e7f679fcSJeremy L Thompson   CeedCheck(l_size >= num_elem * elem_size * num_comp, ceed, CEED_ERROR_DIMENSION, "L-vector size must be at least num_elem * elem_size * num_comp");
884e022e1f8SJeremy L Thompson 
8852b730f8bSJeremy L Thompson   CeedCall(CeedCalloc(1, rstr));
886db002c03SJeremy L Thompson   CeedCall(CeedReferenceCopy(ceed, &(*rstr)->ceed));
887d1d35e2fSjeremylt   (*rstr)->ref_count  = 1;
888d1d35e2fSjeremylt   (*rstr)->num_elem   = num_elem;
889d1d35e2fSjeremylt   (*rstr)->elem_size  = elem_size;
890d1d35e2fSjeremylt   (*rstr)->num_comp   = num_comp;
891d1d35e2fSjeremylt   (*rstr)->l_size     = l_size;
892e7f679fcSJeremy L Thompson   (*rstr)->num_block  = num_block;
893e7f679fcSJeremy L Thompson   (*rstr)->block_size = block_size;
894fcbe8c06SSebastian Grimberg   (*rstr)->rstr_type  = CEED_RESTRICTION_STRIDED;
8952b730f8bSJeremy L Thompson   CeedCall(CeedMalloc(3, &(*rstr)->strides));
8962b730f8bSJeremy L Thompson   for (CeedInt i = 0; i < 3; i++) (*rstr)->strides[i] = strides[i];
897fcbe8c06SSebastian Grimberg   CeedCall(ceed->ElemRestrictionCreateBlocked(CEED_MEM_HOST, CEED_OWN_POINTER, NULL, NULL, NULL, *rstr));
898e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
8997509a596Sjeremylt }
9007509a596Sjeremylt 
9017509a596Sjeremylt /**
9027c1dbaffSSebastian Grimberg   @brief Copy the pointer to a CeedElemRestriction and set `CeedElemRestrictionApply()` implementation to use the unsigned version.
903c17ec2beSJeremy L Thompson 
904c17ec2beSJeremy L Thompson   Both pointers should be destroyed with `CeedElemRestrictionDestroy()`.
905c17ec2beSJeremy L Thompson 
906c17ec2beSJeremy L Thompson   @param[in]     rstr          CeedElemRestriction to create unsigned reference to
907c17ec2beSJeremy L Thompson   @param[in,out] rstr_unsigned Variable to store unsigned CeedElemRestriction
908c17ec2beSJeremy L Thompson 
909c17ec2beSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
910c17ec2beSJeremy L Thompson 
911c17ec2beSJeremy L Thompson   @ref User
912c17ec2beSJeremy L Thompson **/
913c17ec2beSJeremy L Thompson int CeedElemRestrictionCreateUnsignedCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_unsigned) {
914c17ec2beSJeremy L Thompson   CeedCall(CeedCalloc(1, rstr_unsigned));
915c17ec2beSJeremy L Thompson 
916c17ec2beSJeremy L Thompson   // Copy old rstr
917c17ec2beSJeremy L Thompson   memcpy(*rstr_unsigned, rstr, sizeof(struct CeedElemRestriction_private));
918c17ec2beSJeremy L Thompson   (*rstr_unsigned)->ceed = NULL;
919c17ec2beSJeremy L Thompson   CeedCall(CeedReferenceCopy(rstr->ceed, &(*rstr_unsigned)->ceed));
920c17ec2beSJeremy L Thompson   (*rstr_unsigned)->ref_count = 1;
921c17ec2beSJeremy L Thompson   (*rstr_unsigned)->strides   = NULL;
922c17ec2beSJeremy L Thompson   if (rstr->strides) {
923c17ec2beSJeremy L Thompson     CeedCall(CeedMalloc(3, &(*rstr_unsigned)->strides));
924c17ec2beSJeremy L Thompson     for (CeedInt i = 0; i < 3; i++) (*rstr_unsigned)->strides[i] = rstr->strides[i];
925c17ec2beSJeremy L Thompson   }
9267c1dbaffSSebastian Grimberg   CeedCall(CeedElemRestrictionReferenceCopy(rstr, &(*rstr_unsigned)->rstr_base));
927c17ec2beSJeremy L Thompson 
928c17ec2beSJeremy L Thompson   // Override Apply
929c17ec2beSJeremy L Thompson   (*rstr_unsigned)->Apply = rstr->ApplyUnsigned;
930c17ec2beSJeremy L Thompson   return CEED_ERROR_SUCCESS;
931c17ec2beSJeremy L Thompson }
932c17ec2beSJeremy L Thompson 
933c17ec2beSJeremy L Thompson /**
9347c1dbaffSSebastian Grimberg   @brief Copy the pointer to a CeedElemRestriction and set `CeedElemRestrictionApply()` implementation to use the unoriented version.
9357c1dbaffSSebastian Grimberg 
9367c1dbaffSSebastian Grimberg   Both pointers should be destroyed with `CeedElemRestrictionDestroy()`.
9377c1dbaffSSebastian Grimberg 
9387c1dbaffSSebastian Grimberg   @param[in]     rstr            CeedElemRestriction to create unoriented reference to
9397c1dbaffSSebastian Grimberg   @param[in,out] rstr_unoriented Variable to store unoriented CeedElemRestriction
9407c1dbaffSSebastian Grimberg 
9417c1dbaffSSebastian Grimberg   @return An error code: 0 - success, otherwise - failure
9427c1dbaffSSebastian Grimberg 
9437c1dbaffSSebastian Grimberg   @ref User
9447c1dbaffSSebastian Grimberg **/
9457c1dbaffSSebastian Grimberg int CeedElemRestrictionCreateUnorientedCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_unoriented) {
9467c1dbaffSSebastian Grimberg   CeedCall(CeedCalloc(1, rstr_unoriented));
9477c1dbaffSSebastian Grimberg 
9487c1dbaffSSebastian Grimberg   // Copy old rstr
9497c1dbaffSSebastian Grimberg   memcpy(*rstr_unoriented, rstr, sizeof(struct CeedElemRestriction_private));
9507c1dbaffSSebastian Grimberg   (*rstr_unoriented)->ceed = NULL;
9517c1dbaffSSebastian Grimberg   CeedCall(CeedReferenceCopy(rstr->ceed, &(*rstr_unoriented)->ceed));
9527c1dbaffSSebastian Grimberg   (*rstr_unoriented)->ref_count = 1;
9537c1dbaffSSebastian Grimberg   (*rstr_unoriented)->strides   = NULL;
9547c1dbaffSSebastian Grimberg   if (rstr->strides) {
9557c1dbaffSSebastian Grimberg     CeedCall(CeedMalloc(3, &(*rstr_unoriented)->strides));
9567c1dbaffSSebastian Grimberg     for (CeedInt i = 0; i < 3; i++) (*rstr_unoriented)->strides[i] = rstr->strides[i];
9577c1dbaffSSebastian Grimberg   }
9587c1dbaffSSebastian Grimberg   CeedCall(CeedElemRestrictionReferenceCopy(rstr, &(*rstr_unoriented)->rstr_base));
9597c1dbaffSSebastian Grimberg 
9607c1dbaffSSebastian Grimberg   // Override Apply
9617c1dbaffSSebastian Grimberg   (*rstr_unoriented)->Apply = rstr->ApplyUnoriented;
9627c1dbaffSSebastian Grimberg   return CEED_ERROR_SUCCESS;
9637c1dbaffSSebastian Grimberg }
9647c1dbaffSSebastian Grimberg 
9657c1dbaffSSebastian Grimberg /**
966ea61e9acSJeremy L Thompson   @brief Copy the pointer to a CeedElemRestriction.
9679fd66db6SSebastian Grimberg 
968ea61e9acSJeremy L Thompson   Both pointers should be destroyed with `CeedElemRestrictionDestroy()`.
9699560d06aSjeremylt 
9709fd66db6SSebastian Grimberg   Note: If the value of `rstr_copy` passed into this function is non-NULL, then it is assumed that `rstr_copy` is a pointer to a CeedElemRestriction.
9719fd66db6SSebastian Grimberg         This CeedElemRestriction will be destroyed if `rstr_copy` is the only reference to this CeedElemRestriction.
972ea61e9acSJeremy L Thompson 
973ea61e9acSJeremy L Thompson   @param[in]     rstr      CeedElemRestriction to copy reference to
974ea61e9acSJeremy L Thompson   @param[in,out] rstr_copy Variable to store copied reference
9759560d06aSjeremylt 
9769560d06aSjeremylt   @return An error code: 0 - success, otherwise - failure
9779560d06aSjeremylt 
9789560d06aSjeremylt   @ref User
9799560d06aSjeremylt **/
9802b730f8bSJeremy L Thompson int CeedElemRestrictionReferenceCopy(CeedElemRestriction rstr, CeedElemRestriction *rstr_copy) {
981393ac2cdSJeremy L Thompson   if (rstr != CEED_ELEMRESTRICTION_NONE) CeedCall(CeedElemRestrictionReference(rstr));
9822b730f8bSJeremy L Thompson   CeedCall(CeedElemRestrictionDestroy(rstr_copy));
9839560d06aSjeremylt   *rstr_copy = rstr;
9849560d06aSjeremylt   return CEED_ERROR_SUCCESS;
9859560d06aSjeremylt }
9869560d06aSjeremylt 
9879560d06aSjeremylt /**
988b11c1e72Sjeremylt   @brief Create CeedVectors associated with a CeedElemRestriction
989b11c1e72Sjeremylt 
990ea61e9acSJeremy L Thompson   @param[in]  rstr  CeedElemRestriction
991ea61e9acSJeremy L Thompson   @param[out] l_vec The address of the L-vector to be created, or NULL
992ea61e9acSJeremy L Thompson   @param[out] e_vec The address of the E-vector to be created, or NULL
993b11c1e72Sjeremylt 
994b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
995dfdf5a53Sjeremylt 
9967a982d89SJeremy L. Thompson   @ref User
997b11c1e72Sjeremylt **/
9982b730f8bSJeremy L Thompson int CeedElemRestrictionCreateVector(CeedElemRestriction rstr, CeedVector *l_vec, CeedVector *e_vec) {
999d2643443SJeremy L Thompson   CeedSize e_size, l_size;
1000d1d35e2fSjeremylt   l_size = rstr->l_size;
1001e7f679fcSJeremy L Thompson   e_size = rstr->num_block * rstr->block_size * rstr->elem_size * rstr->num_comp;
10022b730f8bSJeremy L Thompson   if (l_vec) CeedCall(CeedVectorCreate(rstr->ceed, l_size, l_vec));
10032b730f8bSJeremy L Thompson   if (e_vec) CeedCall(CeedVectorCreate(rstr->ceed, e_size, e_vec));
1004e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1005d7b241e6Sjeremylt }
1006d7b241e6Sjeremylt 
1007d7b241e6Sjeremylt /**
1008d9e1f99aSValeria Barra   @brief Restrict an L-vector to an E-vector or apply its transpose
1009d7b241e6Sjeremylt 
1010ea61e9acSJeremy L Thompson   @param[in]  rstr    CeedElemRestriction
1011ea61e9acSJeremy L Thompson   @param[in]  t_mode  Apply restriction or transpose
1012ea61e9acSJeremy L Thompson   @param[in]  u       Input vector (of size @a l_size when t_mode=@ref CEED_NOTRANSPOSE)
1013fcbe8c06SSebastian Grimberg   @param[out] ru      Output vector (of shape [@a num_elem * @a elem_size] when t_mode=@ref CEED_NOTRANSPOSE).
1014fcbe8c06SSebastian Grimberg                         Ordering of the e-vector is decided by the backend.
1015ea61e9acSJeremy L Thompson   @param[in]  request Request or @ref CEED_REQUEST_IMMEDIATE
1016b11c1e72Sjeremylt 
1017b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
1018dfdf5a53Sjeremylt 
10197a982d89SJeremy L. Thompson   @ref User
1020b11c1e72Sjeremylt **/
10212b730f8bSJeremy L Thompson int CeedElemRestrictionApply(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, CeedRequest *request) {
1022d7b241e6Sjeremylt   CeedInt m, n;
1023d7b241e6Sjeremylt 
1024d1d35e2fSjeremylt   if (t_mode == CEED_NOTRANSPOSE) {
1025e7f679fcSJeremy L Thompson     m = rstr->num_block * rstr->block_size * rstr->elem_size * rstr->num_comp;
1026d1d35e2fSjeremylt     n = rstr->l_size;
1027d7b241e6Sjeremylt   } else {
1028d1d35e2fSjeremylt     m = rstr->l_size;
1029e7f679fcSJeremy L Thompson     n = rstr->num_block * rstr->block_size * rstr->elem_size * rstr->num_comp;
1030d7b241e6Sjeremylt   }
10316574a04fSJeremy L Thompson   CeedCheck(n == u->length, rstr->ceed, CEED_ERROR_DIMENSION,
10326574a04fSJeremy L Thompson             "Input vector size %" CeedInt_FMT " not compatible with element restriction (%" CeedInt_FMT ", %" CeedInt_FMT ")", u->length, m, n);
10336574a04fSJeremy L Thompson   CeedCheck(m == ru->length, rstr->ceed, CEED_ERROR_DIMENSION,
10346574a04fSJeremy L Thompson             "Output vector size %" CeedInt_FMT " not compatible with element restriction (%" CeedInt_FMT ", %" CeedInt_FMT ")", ru->length, m, n);
10352b730f8bSJeremy L Thompson   if (rstr->num_elem > 0) CeedCall(rstr->Apply(rstr, t_mode, u, ru, request));
1036e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1037d7b241e6Sjeremylt }
1038d7b241e6Sjeremylt 
1039d7b241e6Sjeremylt /**
1040d9e1f99aSValeria Barra   @brief Restrict an L-vector to a block of an E-vector or apply its transpose
1041be9261b7Sjeremylt 
1042ea61e9acSJeremy L Thompson   @param[in]  rstr    CeedElemRestriction
1043e7f679fcSJeremy L Thompson   @param[in]  block   Block number to restrict to/from, i.e. block=0 will handle elements [0 : block_size] and block=3 will handle elements
1044e7f679fcSJeremy L Thompson [3*block_size : 4*block_size]
1045ea61e9acSJeremy L Thompson   @param[in]  t_mode  Apply restriction or transpose
1046ea61e9acSJeremy L Thompson   @param[in]  u       Input vector (of size @a l_size when t_mode=@ref CEED_NOTRANSPOSE)
1047e7f679fcSJeremy L Thompson   @param[out] ru      Output vector (of shape [@a block_size * @a elem_size] when t_mode=@ref CEED_NOTRANSPOSE).
1048fcbe8c06SSebastian Grimberg                         Ordering of the e-vector is decided by the backend.
1049ea61e9acSJeremy L Thompson   @param[in]  request Request or @ref CEED_REQUEST_IMMEDIATE
1050be9261b7Sjeremylt 
1051be9261b7Sjeremylt   @return An error code: 0 - success, otherwise - failure
1052be9261b7Sjeremylt 
10537a982d89SJeremy L. Thompson   @ref Backend
1054be9261b7Sjeremylt **/
10552b730f8bSJeremy L Thompson int CeedElemRestrictionApplyBlock(CeedElemRestriction rstr, CeedInt block, CeedTransposeMode t_mode, CeedVector u, CeedVector ru,
10562b730f8bSJeremy L Thompson                                   CeedRequest *request) {
1057be9261b7Sjeremylt   CeedInt m, n;
1058be9261b7Sjeremylt 
10596402da51SJeremy L Thompson   CeedCheck(rstr->ApplyBlock, rstr->ceed, CEED_ERROR_UNSUPPORTED, "Backend does not implement ElemRestrictionApplyBlock");
10606402da51SJeremy L Thompson 
1061d1d35e2fSjeremylt   if (t_mode == CEED_NOTRANSPOSE) {
1062e7f679fcSJeremy L Thompson     m = rstr->block_size * rstr->elem_size * rstr->num_comp;
1063d1d35e2fSjeremylt     n = rstr->l_size;
1064be9261b7Sjeremylt   } else {
1065d1d35e2fSjeremylt     m = rstr->l_size;
1066e7f679fcSJeremy L Thompson     n = rstr->block_size * rstr->elem_size * rstr->num_comp;
1067be9261b7Sjeremylt   }
10686574a04fSJeremy L Thompson   CeedCheck(n == u->length, rstr->ceed, CEED_ERROR_DIMENSION,
10696574a04fSJeremy L Thompson             "Input vector size %" CeedInt_FMT " not compatible with element restriction (%" CeedInt_FMT ", %" CeedInt_FMT ")", u->length, m, n);
10706574a04fSJeremy L Thompson   CeedCheck(m == ru->length, rstr->ceed, CEED_ERROR_DIMENSION,
10716574a04fSJeremy L Thompson             "Output vector size %" CeedInt_FMT " not compatible with element restriction (%" CeedInt_FMT ", %" CeedInt_FMT ")", ru->length, m, n);
1072e7f679fcSJeremy L Thompson   CeedCheck(rstr->block_size * block <= rstr->num_elem, rstr->ceed, CEED_ERROR_DIMENSION,
1073e7f679fcSJeremy L Thompson             "Cannot retrieve block %" CeedInt_FMT ", element %" CeedInt_FMT " > total elements %" CeedInt_FMT "", block, rstr->block_size * block,
10746574a04fSJeremy L Thompson             rstr->num_elem);
10752b730f8bSJeremy L Thompson   CeedCall(rstr->ApplyBlock(rstr, block, t_mode, u, ru, request));
1076e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1077be9261b7Sjeremylt }
1078be9261b7Sjeremylt 
1079be9261b7Sjeremylt /**
1080b7c9bbdaSJeremy L Thompson   @brief Get the Ceed associated with a CeedElemRestriction
1081b7c9bbdaSJeremy L Thompson 
1082ea61e9acSJeremy L Thompson   @param[in]  rstr CeedElemRestriction
1083b7c9bbdaSJeremy L Thompson   @param[out] ceed Variable to store Ceed
1084b7c9bbdaSJeremy L Thompson 
1085b7c9bbdaSJeremy L Thompson   @return An error code: 0 - success, otherwise - failure
1086b7c9bbdaSJeremy L Thompson 
1087b7c9bbdaSJeremy L Thompson   @ref Advanced
1088b7c9bbdaSJeremy L Thompson **/
1089b7c9bbdaSJeremy L Thompson int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, Ceed *ceed) {
1090b7c9bbdaSJeremy L Thompson   *ceed = rstr->ceed;
1091b7c9bbdaSJeremy L Thompson   return CEED_ERROR_SUCCESS;
1092b7c9bbdaSJeremy L Thompson }
1093b7c9bbdaSJeremy L Thompson 
1094b7c9bbdaSJeremy L Thompson /**
1095d979a051Sjeremylt   @brief Get the L-vector component stride
1096a681ae63Sjeremylt 
1097ea61e9acSJeremy L Thompson   @param[in]  rstr        CeedElemRestriction
1098d1d35e2fSjeremylt   @param[out] comp_stride Variable to store component stride
1099a681ae63Sjeremylt 
1100a681ae63Sjeremylt   @return An error code: 0 - success, otherwise - failure
1101a681ae63Sjeremylt 
1102b7c9bbdaSJeremy L Thompson   @ref Advanced
1103a681ae63Sjeremylt **/
11042b730f8bSJeremy L Thompson int CeedElemRestrictionGetCompStride(CeedElemRestriction rstr, CeedInt *comp_stride) {
1105d1d35e2fSjeremylt   *comp_stride = rstr->comp_stride;
1106e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1107a681ae63Sjeremylt }
1108a681ae63Sjeremylt 
1109a681ae63Sjeremylt /**
1110a681ae63Sjeremylt   @brief Get the total number of elements in the range of a CeedElemRestriction
1111a681ae63Sjeremylt 
1112ea61e9acSJeremy L Thompson   @param[in] rstr      CeedElemRestriction
1113d1d35e2fSjeremylt   @param[out] num_elem Variable to store number of elements
1114a681ae63Sjeremylt 
1115a681ae63Sjeremylt   @return An error code: 0 - success, otherwise - failure
1116a681ae63Sjeremylt 
1117b7c9bbdaSJeremy L Thompson   @ref Advanced
1118a681ae63Sjeremylt **/
11192b730f8bSJeremy L Thompson int CeedElemRestrictionGetNumElements(CeedElemRestriction rstr, CeedInt *num_elem) {
1120d1d35e2fSjeremylt   *num_elem = rstr->num_elem;
1121e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1122a681ae63Sjeremylt }
1123a681ae63Sjeremylt 
1124a681ae63Sjeremylt /**
1125a681ae63Sjeremylt   @brief Get the size of elements in the CeedElemRestriction
1126a681ae63Sjeremylt 
1127ea61e9acSJeremy L Thompson   @param[in]  rstr      CeedElemRestriction
1128d1d35e2fSjeremylt   @param[out] elem_size Variable to store size of elements
1129a681ae63Sjeremylt 
1130a681ae63Sjeremylt   @return An error code: 0 - success, otherwise - failure
1131a681ae63Sjeremylt 
1132b7c9bbdaSJeremy L Thompson   @ref Advanced
1133a681ae63Sjeremylt **/
11342b730f8bSJeremy L Thompson int CeedElemRestrictionGetElementSize(CeedElemRestriction rstr, CeedInt *elem_size) {
1135d1d35e2fSjeremylt   *elem_size = rstr->elem_size;
1136e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1137a681ae63Sjeremylt }
1138a681ae63Sjeremylt 
1139a681ae63Sjeremylt /**
1140d979a051Sjeremylt   @brief Get the size of the l-vector for a CeedElemRestriction
1141a681ae63Sjeremylt 
1142ea61e9acSJeremy L Thompson   @param[in]  rstr   CeedElemRestriction
1143d1d35e2fSjeremylt   @param[out] l_size Variable to store number of nodes
1144a681ae63Sjeremylt 
1145a681ae63Sjeremylt   @return An error code: 0 - success, otherwise - failure
1146a681ae63Sjeremylt 
1147b7c9bbdaSJeremy L Thompson   @ref Advanced
1148a681ae63Sjeremylt **/
11492b730f8bSJeremy L Thompson int CeedElemRestrictionGetLVectorSize(CeedElemRestriction rstr, CeedSize *l_size) {
1150d1d35e2fSjeremylt   *l_size = rstr->l_size;
1151e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1152a681ae63Sjeremylt }
1153a681ae63Sjeremylt 
1154a681ae63Sjeremylt /**
1155ea61e9acSJeremy L Thompson   @brief Get the number of components in the elements of a CeedElemRestriction
1156a681ae63Sjeremylt 
1157ea61e9acSJeremy L Thompson   @param[in]  rstr     CeedElemRestriction
1158d1d35e2fSjeremylt   @param[out] num_comp Variable to store number of components
1159a681ae63Sjeremylt 
1160a681ae63Sjeremylt   @return An error code: 0 - success, otherwise - failure
1161a681ae63Sjeremylt 
1162b7c9bbdaSJeremy L Thompson   @ref Advanced
1163a681ae63Sjeremylt **/
11642b730f8bSJeremy L Thompson int CeedElemRestrictionGetNumComponents(CeedElemRestriction rstr, CeedInt *num_comp) {
1165d1d35e2fSjeremylt   *num_comp = rstr->num_comp;
1166e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1167a681ae63Sjeremylt }
1168a681ae63Sjeremylt 
1169a681ae63Sjeremylt /**
1170a681ae63Sjeremylt   @brief Get the number of blocks in a CeedElemRestriction
1171a681ae63Sjeremylt 
1172ea61e9acSJeremy L Thompson   @param[in]  rstr      CeedElemRestriction
1173d1d35e2fSjeremylt   @param[out] num_block Variable to store number of blocks
1174a681ae63Sjeremylt 
1175a681ae63Sjeremylt   @return An error code: 0 - success, otherwise - failure
1176a681ae63Sjeremylt 
1177b7c9bbdaSJeremy L Thompson   @ref Advanced
1178a681ae63Sjeremylt **/
11792b730f8bSJeremy L Thompson int CeedElemRestrictionGetNumBlocks(CeedElemRestriction rstr, CeedInt *num_block) {
1180e7f679fcSJeremy L Thompson   *num_block = rstr->num_block;
1181e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1182a681ae63Sjeremylt }
1183a681ae63Sjeremylt 
1184a681ae63Sjeremylt /**
1185a681ae63Sjeremylt   @brief Get the size of blocks in the CeedElemRestriction
1186a681ae63Sjeremylt 
1187ea61e9acSJeremy L Thompson   @param[in]  rstr       CeedElemRestriction
1188e7f679fcSJeremy L Thompson   @param[out] block_size Variable to store size of blocks
1189a681ae63Sjeremylt 
1190a681ae63Sjeremylt   @return An error code: 0 - success, otherwise - failure
1191a681ae63Sjeremylt 
1192b7c9bbdaSJeremy L Thompson   @ref Advanced
1193a681ae63Sjeremylt **/
1194e7f679fcSJeremy L Thompson int CeedElemRestrictionGetBlockSize(CeedElemRestriction rstr, CeedInt *block_size) {
1195e7f679fcSJeremy L Thompson   *block_size = rstr->block_size;
1196e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1197a681ae63Sjeremylt }
1198a681ae63Sjeremylt 
1199a681ae63Sjeremylt /**
1200d9e1f99aSValeria Barra   @brief Get the multiplicity of nodes in a CeedElemRestriction
12011469ee4dSjeremylt 
1202ea61e9acSJeremy L Thompson   @param[in]  rstr CeedElemRestriction
1203d1d35e2fSjeremylt   @param[out] mult Vector to store multiplicity (of size l_size)
12041469ee4dSjeremylt 
12051469ee4dSjeremylt   @return An error code: 0 - success, otherwise - failure
12061469ee4dSjeremylt 
12077a982d89SJeremy L. Thompson   @ref User
12081469ee4dSjeremylt **/
12092b730f8bSJeremy L Thompson int CeedElemRestrictionGetMultiplicity(CeedElemRestriction rstr, CeedVector mult) {
1210d1d35e2fSjeremylt   CeedVector e_vec;
12111469ee4dSjeremylt 
121225509ebbSRezgar Shakeri   // Create e_vec to hold intermediate computation in E^T (E 1)
12132b730f8bSJeremy L Thompson   CeedCall(CeedElemRestrictionCreateVector(rstr, NULL, &e_vec));
12141469ee4dSjeremylt 
121525509ebbSRezgar Shakeri   // Compute e_vec = E * 1
12162b730f8bSJeremy L Thompson   CeedCall(CeedVectorSetValue(mult, 1.0));
12172b730f8bSJeremy L Thompson   CeedCall(CeedElemRestrictionApply(rstr, CEED_NOTRANSPOSE, mult, e_vec, CEED_REQUEST_IMMEDIATE));
121825509ebbSRezgar Shakeri   // Compute multiplicity, mult = E^T * e_vec = E^T (E 1)
12192b730f8bSJeremy L Thompson   CeedCall(CeedVectorSetValue(mult, 0.0));
12202b730f8bSJeremy L Thompson   CeedCall(CeedElemRestrictionApply(rstr, CEED_TRANSPOSE, e_vec, mult, CEED_REQUEST_IMMEDIATE));
12211469ee4dSjeremylt   // Cleanup
12222b730f8bSJeremy L Thompson   CeedCall(CeedVectorDestroy(&e_vec));
1223e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
12241469ee4dSjeremylt }
12251469ee4dSjeremylt 
12261469ee4dSjeremylt /**
1227f02ca4a2SJed Brown   @brief View a CeedElemRestriction
1228f02ca4a2SJed Brown 
1229f02ca4a2SJed Brown   @param[in] rstr   CeedElemRestriction to view
1230f02ca4a2SJed Brown   @param[in] stream Stream to write; typically stdout/stderr or a file
1231f02ca4a2SJed Brown 
1232f02ca4a2SJed Brown   @return Error code: 0 - success, otherwise - failure
1233f02ca4a2SJed Brown 
12347a982d89SJeremy L. Thompson   @ref User
1235f02ca4a2SJed Brown **/
1236f02ca4a2SJed Brown int CeedElemRestrictionView(CeedElemRestriction rstr, FILE *stream) {
12377509a596Sjeremylt   char stridesstr[500];
1238*1c66c397SJeremy L Thompson 
12392b730f8bSJeremy L Thompson   if (rstr->strides) {
12402b730f8bSJeremy L Thompson     sprintf(stridesstr, "[%" CeedInt_FMT ", %" CeedInt_FMT ", %" CeedInt_FMT "]", rstr->strides[0], rstr->strides[1], rstr->strides[2]);
12412b730f8bSJeremy L Thompson   } else {
1242990fdeb6SJeremy L Thompson     sprintf(stridesstr, "%" CeedInt_FMT, rstr->comp_stride);
12432b730f8bSJeremy L Thompson   }
12447509a596Sjeremylt 
12452b730f8bSJeremy L Thompson   fprintf(stream, "%sCeedElemRestriction from (%td, %" CeedInt_FMT ") to %" CeedInt_FMT " elements with %" CeedInt_FMT " nodes each and %s %s\n",
1246e7f679fcSJeremy L Thompson           rstr->block_size > 1 ? "Blocked " : "", rstr->l_size, rstr->num_comp, rstr->num_elem, rstr->elem_size,
1247d979a051Sjeremylt           rstr->strides ? "strides" : "component stride", stridesstr);
1248e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1249f02ca4a2SJed Brown }
1250f02ca4a2SJed Brown 
1251f02ca4a2SJed Brown /**
1252b11c1e72Sjeremylt   @brief Destroy a CeedElemRestriction
1253b11c1e72Sjeremylt 
1254ea61e9acSJeremy L Thompson   @param[in,out] rstr CeedElemRestriction to destroy
1255b11c1e72Sjeremylt 
1256b11c1e72Sjeremylt   @return An error code: 0 - success, otherwise - failure
1257dfdf5a53Sjeremylt 
12587a982d89SJeremy L. Thompson   @ref User
1259b11c1e72Sjeremylt **/
12604ce2993fSjeremylt int CeedElemRestrictionDestroy(CeedElemRestriction *rstr) {
1261393ac2cdSJeremy L Thompson   if (!*rstr || *rstr == CEED_ELEMRESTRICTION_NONE || --(*rstr)->ref_count > 0) {
1262ad6481ceSJeremy L Thompson     *rstr = NULL;
1263ad6481ceSJeremy L Thompson     return CEED_ERROR_SUCCESS;
1264ad6481ceSJeremy L Thompson   }
12656574a04fSJeremy L Thompson   CeedCheck((*rstr)->num_readers == 0, (*rstr)->ceed, CEED_ERROR_ACCESS,
12666574a04fSJeremy L Thompson             "Cannot destroy CeedElemRestriction, a process has read access to the offset data");
1267c17ec2beSJeremy L Thompson 
1268c17ec2beSJeremy L Thompson   // Only destroy backend data once between rstr and unsigned copy
12697c1dbaffSSebastian Grimberg   if ((*rstr)->rstr_base) CeedCall(CeedElemRestrictionDestroy(&(*rstr)->rstr_base));
1270c17ec2beSJeremy L Thompson   else if ((*rstr)->Destroy) CeedCall((*rstr)->Destroy(*rstr));
1271c17ec2beSJeremy L Thompson 
12722b730f8bSJeremy L Thompson   CeedCall(CeedFree(&(*rstr)->strides));
12732b730f8bSJeremy L Thompson   CeedCall(CeedDestroy(&(*rstr)->ceed));
12742b730f8bSJeremy L Thompson   CeedCall(CeedFree(rstr));
1275e15f9bd0SJeremy L Thompson   return CEED_ERROR_SUCCESS;
1276d7b241e6Sjeremylt }
1277d7b241e6Sjeremylt 
1278d7b241e6Sjeremylt /// @}
1279