libceed-sys 0.12.0

Low-level bindings for libCEED library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

// Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors.
// All Rights Reserved. See the top-level LICENSE and NOTICE files for details.
//
// SPDX-License-Identifier: BSD-2-Clause
//
// This file is part of CEED:  http://github.com/ceed

#ifndef CEED_OCCA_VECTOR_HEADER
#define CEED_OCCA_VECTOR_HEADER

#include "ceed-occa-ceed-object.hpp"

namespace ceed {
namespace occa {
template <class TM>
::occa::memory arrayToMemory(const TM *array) {
  if (array) {
    ::occa::memory mem((::occa::modeMemory_t *)array);
    mem.setDtype(::occa::dtype::get<TM>());
    return mem;
  }
  return ::occa::null;
}

template <class TM>
TM *memoryToArray(::occa::memory &memory) {
  return (TM *)memory.getModeMemory();
}

class Vector : public CeedObject {
 public:
  // Owned resources
  CeedSize       length;
  ::occa::memory memory;
  CeedSize       hostBufferLength;
  CeedScalar    *hostBuffer;

  ::occa::kernel setValueKernel;

  // Current resources
  ::occa::memory currentMemory;
  CeedScalar    *currentHostBuffer;

  // State information
  int syncState;

  Vector();

  ~Vector();

  int hasValidArray(bool *has_valid_array);

  int hasBorrowedArrayOfType(CeedMemType mem_type, bool *has_borrowed_array_of_type);

  static Vector *getVector(CeedVector vec, const bool assertValid = true);

  static Vector *from(CeedVector vec);

  void resize(const CeedSize length_);

  void resizeMemory(const CeedSize length_);

  void resizeMemory(::occa::device device, const CeedSize length_);

  void resizeHostBuffer(const CeedSize length_);

  void setCurrentMemoryIfNeeded();

  void setCurrentHostBufferIfNeeded();

  void freeHostBuffer();

  int setValue(CeedScalar value);

  int setArray(CeedMemType mtype, CeedCopyMode cmode, CeedScalar *array);

  int takeArray(CeedMemType mtype, CeedScalar **array);

  int copyArrayValues(CeedMemType mtype, CeedScalar *array);

  int ownArrayPointer(CeedMemType mtype, CeedScalar *array);

  int useArrayPointer(CeedMemType mtype, CeedScalar *array);

  int getArray(CeedMemType mtype, CeedScalar **array);

  int getReadOnlyArray(CeedMemType mtype, CeedScalar **array);

  int getWriteOnlyArray(CeedMemType mtype, CeedScalar **array);

  int restoreArray(CeedScalar **array);

  int restoreReadOnlyArray(CeedScalar **array);

  ::occa::memory getKernelArg();

  ::occa::memory getConstKernelArg();

  void printValues(const std::string &name);
  void printNonZeroValues(const std::string &name);
  void printSummary(const std::string &name);

  //---[ Ceed Callbacks ]-----------
  static int registerCeedFunction(Ceed ceed, CeedVector vec, const char *fname, ceed::occa::ceedFunction f);

  static int ceedHasValidArray(CeedVector vec, bool *has_valid_array);

  static int ceedHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type);

  static int ceedCreate(CeedSize length, CeedVector vec);

  static int ceedSetValue(CeedVector vec, CeedScalar value);

  static int ceedSetArray(CeedVector vec, CeedMemType mtype, CeedCopyMode cmode, CeedScalar *array);

  static int ceedTakeArray(CeedVector vec, CeedMemType mtype, CeedScalar **array);

  static int ceedGetArray(CeedVector vec, CeedMemType mtype, CeedScalar **array);

  static int ceedGetArrayRead(CeedVector vec, CeedMemType mtype, CeedScalar **array);

  static int ceedGetArrayWrite(CeedVector vec, CeedMemType mtype, CeedScalar **array);

  static int ceedRestoreArray(CeedVector vec, CeedScalar **array);

  static int ceedRestoreArrayRead(CeedVector vec, CeedScalar **array);

  static int ceedDestroy(CeedVector vec);
};
}  // namespace occa
}  // namespace ceed

#endif