CeedQFunction

typedef struct CeedQFunctionField_private *CeedQFunctionField

Handle for object describing CeedQFunction fields.

int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed)

Get the Ceed associated with a CeedQFunction.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] ceed: Variable to store Ceed

int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vlength)

Get the vector length of a CeedQFunction.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] vlength: Variable to store vector length

int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *numinput, CeedInt *numoutput)

Get the number of inputs and outputs to a CeedQFunction.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] numinput: Variable to store number of input fields

  • [out] numoutput: Variable to store number of output fields

int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source)

Get the source path string for a CeedQFunction.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] source: Variable to store source path string

int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f)

Get the User Function for a CeedQFunction.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] f: Variable to store user function

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

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] ctx: Variable to store CeedQFunctionContext

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.

Return

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

Parameters
  • qf: CeedQFunction

  • [out] ctx: Variable to store CeedQFunctionContext

int CeedQFunctionIsIdentity(CeedQFunction qf, bool *isidentity)

Determine if QFunction is identity.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] isidentity: Variable to store identity status

int CeedQFunctionGetData(CeedQFunction qf, void *data)

Get backend data of a CeedQFunction.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] data: Variable to store data

int CeedQFunctionSetData(CeedQFunction qf, void *data)

Set backend data of a CeedQFunction.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • [out] qf: CeedQFunction

  • data: Data to set

int CeedQFunctionGetFields(CeedQFunction qf, CeedQFunctionField **inputfields, CeedQFunctionField **outputfields)

Get the CeedQFunctionFields of a CeedQFunction.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qf: CeedQFunction

  • [out] inputfields: Variable to store inputfields

  • [out] outputfields: Variable to store outputfields

int CeedQFunctionFieldGetName(CeedQFunctionField qffield, char **fieldname)

Get the name of a CeedQFunctionField.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qffield: CeedQFunctionField

  • [out] fieldname: Variable to store the field name

int CeedQFunctionFieldGetSize(CeedQFunctionField qffield, CeedInt *size)

Get the number of components of a CeedQFunctionField.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qffield: CeedQFunctionField

  • [out] size: Variable to store the size of the field

int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qffield, CeedEvalMode *emode)

Get the CeedEvalMode of a CeedQFunctionField.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • qffield: CeedQFunctionField

  • [out] emode: Variable to store the field evaluation mode

int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed)

Get the Ceed associated with a CeedQFunctionContext.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • ctx: CeedQFunctionContext

  • [out] ceed: Variable to store Ceed

int CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state)

Get the state of a CeedQFunctionContext.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • ctx: CeedQFunctionContext to retrieve state

  • [out] state: Variable to store state

int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, size_t *ctxsize)

Get data size for a Context.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • ctx: CeedQFunctionContext

  • [out] ctxsize: Variable to store size of context data values

int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data)

Get backend data of a CeedQFunctionContext.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • ctx: CeedQFunctionContext

  • [out] data: Variable to store data

int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data)

Set backend data of a CeedQFunctionContext.

Backend Developer Functions

Return

An error code: 0 - success, otherwise - failure

Parameters
  • [out] ctx: CeedQFunctionContext

  • data: Data to set