libCEED/interface/ceed-object.c

1 // Copyright (c) 2017-2026, Lawrence Livermore National Security, LLC and other CEED contributors.
2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
4 // SPDX-License-Identifier: BSD-2-Clause
8 #include <ceed-impl.h>
15 /// ----------------------------------------------------------------------------
17 /// ----------------------------------------------------------------------------
33   @return An error code: 0 - success, otherwise - failure
38   obj->ceed = NULL;  in CeedObjectCreate()
39   if (ceed) CeedCall(CeedReferenceCopy(ceed, &obj->ceed));  in CeedObjectCreate()
40   obj->View = view_function;  in CeedObjectCreate()
42   obj->Destroy   = destroy_function;  in CeedObjectCreate()
43   obj->ref_count = 1;  in CeedObjectCreate()
52   @return An error code: 0 - success, otherwise - failure
57   obj->ref_count++;  in CeedObjectReference()
71   return --obj->ref_count;  // prefix notation, to get new number of references  in CeedObjectDereference()
79   @return An error code: 0 - success, otherwise - failure
84   CeedCheck(obj->ref_count == 0, CeedObjectReturnCeed(obj), CEED_ERROR_UNSUPPORTED,  in CeedObjectDestroy_Private()
86   if (obj->ceed) CeedCall(CeedDestroy(&obj->ceed));  in CeedObjectDestroy_Private()
92 /// ----------------------------------------------------------------------------
94 /// ----------------------------------------------------------------------------
104   @return An error code: 0 - success, otherwise - failure
109   if (obj->View) CeedCall(obj->View(obj, stream));  in CeedObjectView()
119   @return Error code: 0 - success, otherwise - failure
124 …abs >= 0, CeedObjectReturnCeed(obj), CEED_ERROR_MINOR, "Number of view tabs must be non-negative");  in CeedObjectSetNumViewTabs()
125   obj->num_view_tabs = num_tabs;  in CeedObjectSetNumViewTabs()
135   @return Error code: 0 - success, otherwise - failure
140   *num_tabs = obj->num_view_tabs;  in CeedObjectGetNumViewTabs()
150   @return An error code: 0 - success, otherwise - failure
169 Ceed CeedObjectReturnCeed(CeedObject obj) { return (obj->ceed) ? obj->ceed : (Ceed)obj; }  in CeedObjectReturnCeed()
176   @return An error code: 0 - success, otherwise - failure
181   CeedCall((*obj)->Destroy(obj));  in CeedObjectDestroy()