CeedQFunction

typedef struct CeedQFunctionField_private *CeedQFunctionField

Handle for object describing CeedQFunction fields.

int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vec_length)

Get the vector length of a CeedQFunction.

Backend Developer Functions

Parameters
  • qf – CeedQFunction

  • vec_length[out] Variable to store vector length

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *num_input, CeedInt *num_output)

Get the number of inputs and outputs to a CeedQFunction.

Backend Developer Functions

Parameters
  • qf – CeedQFunction

  • num_input[out] Variable to store number of input fields

  • num_output[out] Variable to store number of output fields

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source)

Get the source path string for a CeedQFunction.

Backend Developer Functions

Parameters
  • qf – CeedQFunction

  • source[out] Variable to store source path string

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f)

Get the User Function for a CeedQFunction.

Backend Developer Functions

Parameters
  • qf – CeedQFunction

  • f[out] Variable to store user function

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx)

Get global context for a CeedQFunction.

Note: For QFunctions from the Fortran interface, this function will return the Fortran context CeedQFunctionContext.

Backend Developer Functions

Parameters
  • qf – CeedQFunction

  • ctx[out] Variable to store CeedQFunctionContext

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx)

Get true user context for a CeedQFunction Note: For all QFunctions this function will return the user CeedQFunctionContext and not interface context CeedQFunctionContext, if any such object exists.

Parameters
  • qf – CeedQFunction

  • ctx[out] Variable to store CeedQFunctionContext

Returns

An error code: 0 - success, otherwise - failure Backend Developer Functions

int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity)

Determine if QFunction is identity.

Backend Developer Functions

Parameters
  • qf – CeedQFunction

  • is_identity[out] Variable to store identity status

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionGetData(CeedQFunction qf, void *data)

Get backend data of a CeedQFunction.

Backend Developer Functions

Parameters
  • qf – CeedQFunction

  • data[out] Variable to store data

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionSetData(CeedQFunction qf, void *data)

Set backend data of a CeedQFunction.

Backend Developer Functions

Parameters
  • qf[out] CeedQFunction

  • data – Data to set

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionReference(CeedQFunction qf)

Increment the reference counter for a CeedQFunction.

Backend Developer Functions

Parameters
  • qf – CeedQFunction to increment the reference counter

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed)

Get the Ceed associated with a CeedQFunctionContext.

Backend Developer Functions

Parameters
  • ctx – CeedQFunctionContext

  • ceed[out] Variable to store Ceed

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state)

Get the state of a CeedQFunctionContext.

Backend Developer Functions

Parameters
  • ctx – CeedQFunctionContext to retrieve state

  • state[out] Variable to store state

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data)

Get backend data of a CeedQFunctionContext.

Backend Developer Functions

Parameters
  • ctx – CeedQFunctionContext

  • data[out] Variable to store data

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data)

Set backend data of a CeedQFunctionContext.

Backend Developer Functions

Parameters
  • ctx[out] CeedQFunctionContext

  • data – Data to set

Returns

An error code: 0 - success, otherwise - failure

int CeedQFunctionContextReference(CeedQFunctionContext ctx)

Increment the reference counter for a CeedQFunctionContext.

Backend Developer Functions

Parameters
  • ctx – CeedQFunctionContext to increment the reference counter

Returns

An error code: 0 - success, otherwise - failure