Actual source code: state.c

  1: #define PETSC_DLL
  2: /*
  3:      Provides utility routines for manulating any type of PETSc object.
  4: */
 5:  #include petsc.h

  9: /*@C
 10:    PetscObjectStateQuery - Gets the state of any PetscObject, 
 11:    regardless of the type.

 13:    Not Collective

 15:    Input Parameter:
 16: .  obj - any PETSc object, for example a Vec, Mat or KSP. This must be
 17:          cast with a (PetscObject), for example, 
 18:          PetscObjectStateQuery((PetscObject)mat,&state);

 20:    Output Parameter:
 21: .  state - the object state

 23:    Notes: object state is an integer which gets increased every time
 24:    the object is changed. By saving and later querying the object state
 25:    one can determine whether information about the object is still current.
 26:    Currently, state is maintained for Vec and Mat objects.

 28:    Level: advanced

 30:    seealso: PetscObjectStateIncrease, PetscObjectSetState

 32:    Concepts: state

 34: @*/
 35: PetscErrorCode  PetscObjectStateQuery(PetscObject obj,PetscInt *state)
 36: {
 38:   if (!obj) SETERRQ(PETSC_ERR_ARG_CORRUPT,"Null object");
 39:   *state = obj->state;
 40:   return(0);
 41: }

 45: /*@C
 46:    PetscObjectSetState - Sets the state of any PetscObject, 
 47:    regardless of the type.

 49:    Not Collective

 51:    Input Parameter:
 52: +  obj - any PETSc object, for example a Vec, Mat or KSP. This must be
 53:          cast with a (PetscObject), for example, 
 54:          PetscObjectSetState((PetscObject)mat,state);
 55: -  state - the object state

 57:    Notes: This function should be used with extreme caution. There is 
 58:    essentially only one use for it: if the user calls Mat(Vec)GetRow(Array),
 59:    which increases the state, but does not alter the data, then this 
 60:    routine can be used to reset the state.

 62:    Level: advanced

 64:    seealso: PetscObjectStateQuery,PetscObjectStateIncrease

 66:    Concepts: state

 68: @*/
 69: PetscErrorCode  PetscObjectSetState(PetscObject obj,PetscInt state)
 70: {
 72:   if (!obj) SETERRQ(PETSC_ERR_ARG_CORRUPT,"Null object");
 73:   obj->state = state;
 74:   return(0);
 75: }

 77: PetscInt  globalcurrentstate = 0;
 78: PetscInt  globalmaxstate = 10;
 79: /*@C
 80:    PetscObjectComposedDataRegister - Get an available id for 
 81:    composed data

 83:    Not Collective

 85:    Output parameter:
 86: .  id - an identifier under which data can be stored

 88:    Level: developer

 90:    seealso: PetscObjectComposedDataSetInt

 92: @*/
 93: PetscErrorCode  PetscObjectComposedDataRegister(PetscInt *id)
 94: {
 96:   *id = globalcurrentstate++;
 97:   if (globalcurrentstate > globalmaxstate) globalmaxstate += 10;
 98:   return(0);
 99: }

101: PetscErrorCode  PetscObjectComposedDataIncreaseInt(PetscObject obj)
102: {
103:   PetscInt       *ar = obj->intcomposeddata,*new_ar;
104:   PetscInt       *ir = obj->intcomposedstate,*new_ir,n = obj->int_idmax,new_n,i;

108:   new_n = globalmaxstate;
109:   PetscMalloc(new_n*sizeof(PetscInt),&new_ar);
110:   PetscMemzero(new_ar,new_n*sizeof(PetscInt));
111:   PetscMalloc(new_n*sizeof(PetscInt),&new_ir);
112:   PetscMemzero(new_ir,new_n*sizeof(PetscInt));
113:   if (n) {
114:     for (i=0; i<n; i++) {
115:       new_ar[i] = ar[i]; new_ir[i] = ir[i];
116:     }
117:     PetscFree(ar);
118:     PetscFree(ir);
119:   }
120:   obj->int_idmax = new_n;
121:   obj->intcomposeddata = new_ar; obj->intcomposedstate = new_ir;
122:   return(0);
123: }
124: PetscErrorCode  PetscObjectComposedDataIncreaseIntstar(PetscObject obj)
125: {
126:   PetscInt       **ar = obj->intstarcomposeddata,**new_ar;
127:   PetscInt       *ir = obj->intstarcomposedstate,*new_ir,n = obj->intstar_idmax,new_n,i;

131:   new_n = globalmaxstate;
132:   PetscMalloc(new_n*sizeof(PetscInt*),&new_ar);
133:   PetscMemzero(new_ar,new_n*sizeof(PetscInt*));
134:   PetscMalloc(new_n*sizeof(PetscInt),&new_ir);
135:   PetscMemzero(new_ir,new_n*sizeof(PetscInt));
136:   if (n) {
137:     for (i=0; i<n; i++) {
138:       new_ar[i] = ar[i]; new_ir[i] = ir[i];
139:     }
140:     PetscFree(ar);
141:     PetscFree(ir);
142:   }
143:   obj->intstar_idmax = new_n;
144:   obj->intstarcomposeddata = new_ar; obj->intstarcomposedstate = new_ir;
145:   return(0);
146: }

148: PetscErrorCode  PetscObjectComposedDataIncreaseReal(PetscObject obj)
149: {
150:   PetscReal      *ar = obj->realcomposeddata,*new_ar;
151:   PetscInt       *ir = obj->realcomposedstate,*new_ir,n = obj->real_idmax,new_n,i;

155:   new_n = globalmaxstate;
156:   PetscMalloc(new_n*sizeof(PetscReal),&new_ar);
157:   PetscMemzero(new_ar,new_n*sizeof(PetscReal));
158:   PetscMalloc(new_n*sizeof(PetscInt),&new_ir);
159:   PetscMemzero(new_ir,new_n*sizeof(PetscInt));
160:   if (n) {
161:     for (i=0; i<n; i++) {
162:       new_ar[i] = ar[i]; new_ir[i] = ir[i];
163:     }
164:     PetscFree(ar);
165:     PetscFree(ir);
166:   }
167:   obj->real_idmax = new_n;
168:   obj->realcomposeddata = new_ar; obj->realcomposedstate = new_ir;
169:   return(0);
170: }

172: PetscErrorCode  PetscObjectComposedDataIncreaseRealstar(PetscObject obj)
173: {
174:   PetscReal      **ar = obj->realstarcomposeddata,**new_ar;
175:   PetscInt       *ir = obj->realstarcomposedstate,*new_ir,n = obj->realstar_idmax,new_n,i;

179:   new_n = globalmaxstate;
180:   PetscMalloc(new_n*sizeof(PetscReal*),&new_ar);
181:   PetscMemzero(new_ar,new_n*sizeof(PetscReal*));
182:   PetscMalloc(new_n*sizeof(PetscInt),&new_ir);
183:   PetscMemzero(new_ir,new_n*sizeof(PetscInt));
184:   if (n) {
185:     for (i=0; i<n; i++) {
186:       new_ar[i] = ar[i]; new_ir[i] = ir[i];
187:     }
188:     PetscFree(ar);
189:     PetscFree(ir);
190:   }
191:   obj->realstar_idmax = new_n;
192:   obj->realstarcomposeddata = new_ar; obj->realstarcomposedstate = new_ir;
193:   return(0);
194: }

196: PetscErrorCode  PetscObjectComposedDataIncreaseScalar(PetscObject obj)
197: {
198:   PetscScalar    *ar = obj->scalarcomposeddata,*new_ar;
199:   PetscInt       *ir = obj->scalarcomposedstate,*new_ir,n = obj->scalar_idmax,new_n,i;

203:   new_n = globalmaxstate;
204:   PetscMalloc(new_n*sizeof(PetscScalar),&new_ar);
205:   PetscMemzero(new_ar,new_n*sizeof(PetscScalar));
206:   PetscMalloc(new_n*sizeof(PetscInt),&new_ir);
207:   PetscMemzero(new_ir,new_n*sizeof(PetscInt));
208:   if (n) {
209:     for (i=0; i<n; i++) {
210:       new_ar[i] = ar[i]; new_ir[i] = ir[i];
211:     }
212:     PetscFree(ar);
213:     PetscFree(ir);
214:   }
215:   obj->scalar_idmax = new_n;
216:   obj->scalarcomposeddata = new_ar; obj->scalarcomposedstate = new_ir;
217:   return(0);
218: }

220: PetscErrorCode  PetscObjectComposedDataIncreaseScalarstar(PetscObject obj)
221: {
222:   PetscScalar    **ar = obj->scalarstarcomposeddata,**new_ar;
223:   PetscInt       *ir = obj->scalarstarcomposedstate,*new_ir,n = obj->scalarstar_idmax,new_n,i;

227:   new_n = globalmaxstate;
228:   PetscMalloc(new_n*sizeof(PetscScalar*),&new_ar);
229:   PetscMemzero(new_ar,new_n*sizeof(PetscScalar*));
230:   PetscMalloc(new_n*sizeof(PetscInt),&new_ir);
231:   PetscMemzero(new_ir,new_n*sizeof(PetscInt));
232:   if (n) {
233:     for (i=0; i<n; i++) {
234:       new_ar[i] = ar[i]; new_ir[i] = ir[i];
235:     }
236:     PetscFree(ar);
237:     PetscFree(ir);
238:   }
239:   obj->scalarstar_idmax = new_n;
240:   obj->scalarstarcomposeddata = new_ar; obj->scalarstarcomposedstate = new_ir;
241:   return(0);
242: }