DFShellCreate

Creates a discrete function object.

Synopsis

int DFShellCreate(MPI_Comm comm,DFType type,int dim,int nc,DFComponentOrdering ord,
                 char **label,int n0,int n1,int n2,DF* df)

Input Parameters

comm - MPI communicator
type - type of discrete function, one of DF_SEQGEN (general sequential), DF_SEQREG (regular sequential), or DF_MPIGEN (general parallel)
dim - number of problem dimensions (1, 2, or 3)
nc - number of components per grid point
ord - grid component ordering, either ORDER_1 (ordering by components most rapidly) or ORDER_2 (ordering 1 component for whole grid, then the next component, etc.)
label - optional character string associated with each component
n0, n1, n2 - number of grid points in each dimension

Output Parameter

df -discrete function (DF) shell

Notes

When using PETSc distributed arrays (DAs), the vectors obtained fromDACreateGlobalVector() and DACreateLocalVector() are automaticallydiscrete function vectors (DAVec's) of the type DF_MPIREG. Thus, users of DAs need not be concerned with DFShellCreate() at all, since this routine is intended for use with more general types ofvectors.

See Also

DFShellDestroy(), DFShellSetCoordinates()

Location: src/dfvec/interface/dfvec.c
Discrete Function Index
Table of Contents