xref: /petsc/src/snes/utils/dmsnes.c (revision 98da9c48166cffcfbff9057089fde236b0e4c1a6)
1b45d2f2cSJed Brown #include <petsc-private/snesimpl.h>   /*I "petscsnes.h" I*/
2679f678eSPeter Brune #include <petsc-private/dmimpl.h>     /*I "petscdm.h" I*/
36cab3a1bSJed Brown 
46cab3a1bSJed Brown #undef __FUNCT__
522c6f798SBarry Smith #define __FUNCT__ "DMSNESDestroy"
622c6f798SBarry Smith static PetscErrorCode DMSNESDestroy(DMSNES *kdm)
76cab3a1bSJed Brown {
86cab3a1bSJed Brown   PetscErrorCode ierr;
96cab3a1bSJed Brown 
106cab3a1bSJed Brown   PetscFunctionBegin;
1122c6f798SBarry Smith  if (!*kdm) PetscFunctionReturn(0);
1222c6f798SBarry Smith   PetscValidHeaderSpecific((*kdm),DMSNES_CLASSID,1);
1322c6f798SBarry Smith   if (--((PetscObject)(*kdm))->refct > 0) {*kdm = 0; PetscFunctionReturn(0);}
1422c6f798SBarry Smith   if ((*kdm)->ops->destroy) {ierr = ((*kdm)->ops->destroy)(*kdm);CHKERRQ(ierr);}
1522c6f798SBarry Smith   ierr = PetscHeaderDestroy(kdm);CHKERRQ(ierr);
1622c6f798SBarry Smith   PetscFunctionReturn(0);
1722c6f798SBarry Smith }
1822c6f798SBarry Smith 
1922c6f798SBarry Smith #undef __FUNCT__
202d53ad75SBarry Smith #define __FUNCT__ "DMSNESLoad"
212d53ad75SBarry Smith PetscErrorCode DMSNESLoad(DMSNES kdm,PetscViewer viewer)
222d53ad75SBarry Smith {
232d53ad75SBarry Smith   PetscErrorCode ierr;
242d53ad75SBarry Smith 
252d53ad75SBarry Smith   PetscFunctionBegin;
262d53ad75SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&kdm->ops->computefunction,1,PETSC_FUNCTION);CHKERRQ(ierr);
272d53ad75SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&kdm->ops->computejacobian,1,PETSC_FUNCTION);CHKERRQ(ierr);
282d53ad75SBarry Smith   PetscFunctionReturn(0);
292d53ad75SBarry Smith }
302d53ad75SBarry Smith 
312d53ad75SBarry Smith #undef __FUNCT__
322d53ad75SBarry Smith #define __FUNCT__ "DMSNESView"
332d53ad75SBarry Smith PetscErrorCode DMSNESView(DMSNES kdm,PetscViewer viewer)
342d53ad75SBarry Smith {
352d53ad75SBarry Smith   PetscErrorCode ierr;
362d53ad75SBarry Smith   PetscBool      isascii,isbinary;
372d53ad75SBarry Smith 
382d53ad75SBarry Smith   PetscFunctionBegin;
392d53ad75SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
402d53ad75SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
412d53ad75SBarry Smith   if (isascii) {
42c7a10e08SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
432d53ad75SBarry Smith     const char *fname;
442d53ad75SBarry Smith 
452d53ad75SBarry Smith     ierr = PetscFPTFind(kdm->ops->computefunction,&fname);CHKERRQ(ierr);
462d53ad75SBarry Smith     if (fname) {
472d53ad75SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Function used by SNES: %s\n",fname);CHKERRQ(ierr);
482d53ad75SBarry Smith     }
492d53ad75SBarry Smith     ierr = PetscFPTFind(kdm->ops->computejacobian,&fname);CHKERRQ(ierr);
502d53ad75SBarry Smith     if (fname) {
512d53ad75SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Jacobian function used by SNES: %s\n",fname);CHKERRQ(ierr);
522d53ad75SBarry Smith     }
53c7a10e08SBarry Smith #endif
542d53ad75SBarry Smith   } else if (isbinary) {
55*98da9c48SSatish Balay     ierr = PetscViewerBinaryWrite(viewer,(void*)kdm->ops->computefunction,1,PETSC_FUNCTION,PETSC_FALSE);CHKERRQ(ierr);
56*98da9c48SSatish Balay     ierr = PetscViewerBinaryWrite(viewer,(void*)kdm->ops->computejacobian,1,PETSC_FUNCTION,PETSC_FALSE);CHKERRQ(ierr);
572d53ad75SBarry Smith   }
582d53ad75SBarry Smith   PetscFunctionReturn(0);
592d53ad75SBarry Smith }
602d53ad75SBarry Smith 
612d53ad75SBarry Smith #undef __FUNCT__
6222c6f798SBarry Smith #define __FUNCT__ "DMSNESCreate"
6322c6f798SBarry Smith static PetscErrorCode DMSNESCreate(MPI_Comm comm,DMSNES *kdm)
6422c6f798SBarry Smith {
6522c6f798SBarry Smith   PetscErrorCode ierr;
6622c6f798SBarry Smith 
6722c6f798SBarry Smith   PetscFunctionBegin;
6822c6f798SBarry Smith #ifndef PETSC_USE_DYNAMIC_LIBRARIES
6922c6f798SBarry Smith   ierr = SNESInitializePackage(PETSC_NULL);CHKERRQ(ierr);
7022c6f798SBarry Smith #endif
712d53ad75SBarry Smith   ierr = PetscHeaderCreate(*kdm, _p_DMSNES, struct _DMSNESOps, DMSNES_CLASSID, -1, "DMSNES", "DMSNES", "DMSNES", comm, DMSNESDestroy, DMSNESView);CHKERRQ(ierr);
7222c6f798SBarry Smith   ierr = PetscMemzero((*kdm)->ops, sizeof(struct _DMSNESOps));CHKERRQ(ierr);
736cab3a1bSJed Brown   PetscFunctionReturn(0);
746cab3a1bSJed Brown }
756cab3a1bSJed Brown 
766cab3a1bSJed Brown #undef __FUNCT__
77942e3340SBarry Smith #define __FUNCT__ "DMCoarsenHook_DMSNES"
78942e3340SBarry Smith /* Attaches the DMSNES to the coarse level.
796cab3a1bSJed Brown  * Under what conditions should we copy versus duplicate?
806cab3a1bSJed Brown  */
81942e3340SBarry Smith static PetscErrorCode DMCoarsenHook_DMSNES(DM dm,DM dmc,void *ctx)
826cab3a1bSJed Brown {
836cab3a1bSJed Brown   PetscErrorCode ierr;
846cab3a1bSJed Brown 
856cab3a1bSJed Brown   PetscFunctionBegin;
86942e3340SBarry Smith   ierr = DMCopyDMSNES(dm,dmc);CHKERRQ(ierr);
876cab3a1bSJed Brown   PetscFunctionReturn(0);
886cab3a1bSJed Brown }
896cab3a1bSJed Brown 
906cab3a1bSJed Brown #undef __FUNCT__
91942e3340SBarry Smith #define __FUNCT__ "DMRestrictHook_DMSNES"
92dfe15315SJed Brown /* This could restrict auxiliary information to the coarse level.
93caa4e7f2SJed Brown  */
94942e3340SBarry Smith static PetscErrorCode DMRestrictHook_DMSNES(DM dm,Mat Restrict,Vec rscale,Mat Inject,DM dmc,void *ctx)
95caa4e7f2SJed Brown {
96caa4e7f2SJed Brown 
97caa4e7f2SJed Brown   PetscFunctionBegin;
98caa4e7f2SJed Brown   PetscFunctionReturn(0);
99caa4e7f2SJed Brown }
100caa4e7f2SJed Brown 
101caa4e7f2SJed Brown #undef __FUNCT__
102be081cd6SPeter Brune #define __FUNCT__ "DMSubDomainHook_DMSNES"
103be081cd6SPeter Brune /* Attaches the DMSNES to the subdomain. */
104be081cd6SPeter Brune static PetscErrorCode DMSubDomainHook_DMSNES(DM dm,DM subdm,void *ctx)
105be081cd6SPeter Brune {
106be081cd6SPeter Brune   PetscErrorCode ierr;
107be081cd6SPeter Brune 
108be081cd6SPeter Brune   PetscFunctionBegin;
109be081cd6SPeter Brune   ierr = DMCopyDMSNES(dm,subdm);CHKERRQ(ierr);
110be081cd6SPeter Brune   PetscFunctionReturn(0);
111be081cd6SPeter Brune }
112be081cd6SPeter Brune 
113be081cd6SPeter Brune #undef __FUNCT__
114be081cd6SPeter Brune #define __FUNCT__ "DMSubDomainRestrictHook_DMSNES"
115be081cd6SPeter Brune /* This could restrict auxiliary information to the coarse level.
116be081cd6SPeter Brune  */
117be081cd6SPeter Brune static PetscErrorCode DMSubDomainRestrictHook_DMSNES(DM dm,VecScatter gscat,VecScatter lscat,DM subdm,void *ctx)
118be081cd6SPeter Brune {
119be081cd6SPeter Brune 
120be081cd6SPeter Brune   PetscFunctionBegin;
121be081cd6SPeter Brune   PetscFunctionReturn(0);
122be081cd6SPeter Brune }
123be081cd6SPeter Brune 
124be081cd6SPeter Brune #undef __FUNCT__
125942e3340SBarry Smith #define __FUNCT__ "DMRefineHook_DMSNES"
126942e3340SBarry Smith static PetscErrorCode DMRefineHook_DMSNES(DM dm,DM dmf,void *ctx)
12703a0fabfSPeter Brune {
12803a0fabfSPeter Brune   PetscErrorCode ierr;
12903a0fabfSPeter Brune 
13003a0fabfSPeter Brune   PetscFunctionBegin;
131942e3340SBarry Smith   ierr = DMCopyDMSNES(dm,dmf);CHKERRQ(ierr);
13203a0fabfSPeter Brune   PetscFunctionReturn(0);
13303a0fabfSPeter Brune }
13403a0fabfSPeter Brune 
13503a0fabfSPeter Brune #undef __FUNCT__
136942e3340SBarry Smith #define __FUNCT__ "DMInterpolateHook_DMSNES"
13703a0fabfSPeter Brune /* This could restrict auxiliary information to the coarse level.
13803a0fabfSPeter Brune  */
139942e3340SBarry Smith static PetscErrorCode DMInterpolateHook_DMSNES(DM dm,Mat Interp,DM dmf,void *ctx)
14003a0fabfSPeter Brune {
14103a0fabfSPeter Brune 
14203a0fabfSPeter Brune   PetscFunctionBegin;
14303a0fabfSPeter Brune   PetscFunctionReturn(0);
14403a0fabfSPeter Brune }
14503a0fabfSPeter Brune 
14603a0fabfSPeter Brune #undef __FUNCT__
14722c6f798SBarry Smith #define __FUNCT__ "DMSNESCopy"
14822c6f798SBarry Smith /*@C
14922c6f798SBarry Smith    DMSNESCopy - copies the information in a DMSNES to another DMSNES
15022c6f798SBarry Smith 
15122c6f798SBarry Smith    Not Collective
15222c6f798SBarry Smith 
15322c6f798SBarry Smith    Input Argument:
15422c6f798SBarry Smith +  kdm - Original DMSNES
15522c6f798SBarry Smith -  nkdm - DMSNES to receive the data, should have been created with DMSNESCreate()
15622c6f798SBarry Smith 
15722c6f798SBarry Smith    Level: developer
15822c6f798SBarry Smith 
15922c6f798SBarry Smith .seealso: DMSNESCreate(), DMSNESDestroy()
16022c6f798SBarry Smith @*/
16122c6f798SBarry Smith PetscErrorCode DMSNESCopy(DMSNES kdm,DMSNES nkdm)
16222c6f798SBarry Smith {
16322c6f798SBarry Smith   PetscErrorCode ierr;
16422c6f798SBarry Smith 
16522c6f798SBarry Smith   PetscFunctionBegin;
16622c6f798SBarry Smith   PetscValidHeaderSpecific(kdm,DMSNES_CLASSID,1);
16722c6f798SBarry Smith   PetscValidHeaderSpecific(nkdm,DMSNES_CLASSID,2);
16822c6f798SBarry Smith   nkdm->ops->computefunction       = kdm->ops->computefunction;
16922c6f798SBarry Smith   nkdm->ops->computegs             = kdm->ops->computegs;
17022c6f798SBarry Smith   nkdm->ops->computeobjective      = kdm->ops->computeobjective;
17122c6f798SBarry Smith   nkdm->ops->computepjacobian      = kdm->ops->computepjacobian;
17222c6f798SBarry Smith   nkdm->ops->computepfunction      = kdm->ops->computepfunction;
17322c6f798SBarry Smith   nkdm->ops->destroy               = kdm->ops->destroy;
17422c6f798SBarry Smith   nkdm->ops->duplicate             = kdm->ops->duplicate;
17522c6f798SBarry Smith 
17622c6f798SBarry Smith   nkdm->functionctx      = kdm->functionctx;
17722c6f798SBarry Smith   nkdm->gsctx            = kdm->gsctx;
17822c6f798SBarry Smith   nkdm->pctx             = kdm->pctx;
17922c6f798SBarry Smith   nkdm->jacobianctx      = kdm->jacobianctx;
18022c6f798SBarry Smith   nkdm->objectivectx     = kdm->objectivectx;
18122c6f798SBarry Smith   nkdm->data             = kdm->data;
18222c6f798SBarry Smith 
18322c6f798SBarry Smith   /*
18422c6f798SBarry Smith   nkdm->fortran_func_pointers[0] = kdm->fortran_func_pointers[0];
18522c6f798SBarry Smith   nkdm->fortran_func_pointers[1] = kdm->fortran_func_pointers[1];
18622c6f798SBarry Smith   nkdm->fortran_func_pointers[2] = kdm->fortran_func_pointers[2];
18722c6f798SBarry Smith   */
18822c6f798SBarry Smith 
18922c6f798SBarry Smith   /* implementation specific copy hooks */
19022c6f798SBarry Smith   if (kdm->ops->duplicate) {ierr = (*kdm->ops->duplicate)(kdm,nkdm);CHKERRQ(ierr);}
19122c6f798SBarry Smith   PetscFunctionReturn(0);
19222c6f798SBarry Smith }
19322c6f798SBarry Smith 
19422c6f798SBarry Smith #undef __FUNCT__
195942e3340SBarry Smith #define __FUNCT__ "DMGetDMSNES"
1966cab3a1bSJed Brown /*@C
197942e3340SBarry Smith    DMGetDMSNES - get read-only private DMSNES context from a DM
1986cab3a1bSJed Brown 
1996cab3a1bSJed Brown    Not Collective
2006cab3a1bSJed Brown 
2016cab3a1bSJed Brown    Input Argument:
2026cab3a1bSJed Brown .  dm - DM to be used with SNES
2036cab3a1bSJed Brown 
2046cab3a1bSJed Brown    Output Argument:
205942e3340SBarry Smith .  snesdm - private DMSNES context
2066cab3a1bSJed Brown 
2076cab3a1bSJed Brown    Level: developer
2086cab3a1bSJed Brown 
2096cab3a1bSJed Brown    Notes:
210942e3340SBarry Smith    Use DMGetDMSNESWrite() if write access is needed. The DMSNESSetXXX API should be used wherever possible.
2116cab3a1bSJed Brown 
212942e3340SBarry Smith .seealso: DMGetDMSNESWrite()
2136cab3a1bSJed Brown @*/
214942e3340SBarry Smith PetscErrorCode DMGetDMSNES(DM dm,DMSNES *snesdm)
2156cab3a1bSJed Brown {
2166cab3a1bSJed Brown   PetscErrorCode ierr;
2176cab3a1bSJed Brown 
2186cab3a1bSJed Brown   PetscFunctionBegin;
2196cab3a1bSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
220b4615a05SBarry Smith   *snesdm = (DMSNES) dm->dmsnes;
22122c6f798SBarry Smith   if (!*snesdm) {
222942e3340SBarry Smith     ierr = PetscInfo(dm,"Creating new DMSNES\n");CHKERRQ(ierr);
22322c6f798SBarry Smith     ierr = DMSNESCreate(((PetscObject)dm)->comm,snesdm);CHKERRQ(ierr);
224b4615a05SBarry Smith     dm->dmsnes = (PetscObject) *snesdm;
225942e3340SBarry Smith     ierr = DMCoarsenHookAdd(dm,DMCoarsenHook_DMSNES,DMRestrictHook_DMSNES,PETSC_NULL);CHKERRQ(ierr);
22622c6f798SBarry Smith     ierr = DMRefineHookAdd(dm,DMRefineHook_DMSNES,DMInterpolateHook_DMSNES,PETSC_NULL);CHKERRQ(ierr);
227be081cd6SPeter Brune     ierr = DMSubDomainHookAdd(dm,DMSubDomainHook_DMSNES,DMSubDomainRestrictHook_DMSNES,PETSC_NULL);CHKERRQ(ierr);
2286cab3a1bSJed Brown   }
2296cab3a1bSJed Brown   PetscFunctionReturn(0);
2306cab3a1bSJed Brown }
2316cab3a1bSJed Brown 
2326cab3a1bSJed Brown #undef __FUNCT__
233942e3340SBarry Smith #define __FUNCT__ "DMGetDMSNESWrite"
2346cab3a1bSJed Brown /*@C
235942e3340SBarry Smith    DMGetDMSNESWrite - get write access to private DMSNES context from a DM
2366cab3a1bSJed Brown 
2376cab3a1bSJed Brown    Not Collective
2386cab3a1bSJed Brown 
2396cab3a1bSJed Brown    Input Argument:
2406cab3a1bSJed Brown .  dm - DM to be used with SNES
2416cab3a1bSJed Brown 
2426cab3a1bSJed Brown    Output Argument:
243942e3340SBarry Smith .  snesdm - private DMSNES context
2446cab3a1bSJed Brown 
2456cab3a1bSJed Brown    Level: developer
2466cab3a1bSJed Brown 
247942e3340SBarry Smith .seealso: DMGetDMSNES()
2486cab3a1bSJed Brown @*/
249942e3340SBarry Smith PetscErrorCode DMGetDMSNESWrite(DM dm,DMSNES *snesdm)
2506cab3a1bSJed Brown {
2516cab3a1bSJed Brown   PetscErrorCode ierr;
252942e3340SBarry Smith   DMSNES         sdm;
2536cab3a1bSJed Brown 
2546cab3a1bSJed Brown   PetscFunctionBegin;
2556cab3a1bSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
256942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
2576cab3a1bSJed Brown   if (!sdm->originaldm) sdm->originaldm = dm;
2586cab3a1bSJed Brown   if (sdm->originaldm != dm) {  /* Copy on write */
259b4615a05SBarry Smith     DMSNES          oldsdm = sdm;
260942e3340SBarry Smith     ierr = PetscInfo(dm,"Copying DMSNES due to write\n");CHKERRQ(ierr);
26122c6f798SBarry Smith     ierr = DMSNESCreate(((PetscObject)dm)->comm,&sdm);CHKERRQ(ierr);
26222c6f798SBarry Smith     ierr = DMSNESCopy(oldsdm,sdm);CHKERRQ(ierr);
263b4615a05SBarry Smith     ierr = DMSNESDestroy((DMSNES*)&dm->dmsnes);CHKERRQ(ierr);
264b4615a05SBarry Smith     dm->dmsnes = (PetscObject)sdm;
2656cab3a1bSJed Brown   }
2666cab3a1bSJed Brown   *snesdm = sdm;
2676cab3a1bSJed Brown   PetscFunctionReturn(0);
2686cab3a1bSJed Brown }
2696cab3a1bSJed Brown 
2706cab3a1bSJed Brown #undef __FUNCT__
271942e3340SBarry Smith #define __FUNCT__ "DMCopyDMSNES"
2726cab3a1bSJed Brown /*@C
273942e3340SBarry Smith    DMCopyDMSNES - copies a DM context to a new DM
2746cab3a1bSJed Brown 
2756cab3a1bSJed Brown    Logically Collective
2766cab3a1bSJed Brown 
2776cab3a1bSJed Brown    Input Arguments:
2786cab3a1bSJed Brown +  dmsrc - DM to obtain context from
2796cab3a1bSJed Brown -  dmdest - DM to add context to
2806cab3a1bSJed Brown 
2816cab3a1bSJed Brown    Level: developer
2826cab3a1bSJed Brown 
2836cab3a1bSJed Brown    Note:
2846cab3a1bSJed Brown    The context is copied by reference. This function does not ensure that a context exists.
2856cab3a1bSJed Brown 
286942e3340SBarry Smith .seealso: DMGetDMSNES(), SNESSetDM()
2876cab3a1bSJed Brown @*/
288942e3340SBarry Smith PetscErrorCode DMCopyDMSNES(DM dmsrc,DM dmdest)
2896cab3a1bSJed Brown {
2906cab3a1bSJed Brown   PetscErrorCode ierr;
2916cab3a1bSJed Brown 
2926cab3a1bSJed Brown   PetscFunctionBegin;
2936cab3a1bSJed Brown   PetscValidHeaderSpecific(dmsrc,DM_CLASSID,1);
2946cab3a1bSJed Brown   PetscValidHeaderSpecific(dmdest,DM_CLASSID,2);
295b4615a05SBarry Smith   ierr = DMSNESDestroy((DMSNES*)&dmdest->dmsnes);CHKERRQ(ierr);
296b4615a05SBarry Smith   dmdest->dmsnes = dmsrc->dmsnes;
297b4615a05SBarry Smith   ierr = PetscObjectReference(dmdest->dmsnes);CHKERRQ(ierr);
29822c6f798SBarry Smith   ierr = DMCoarsenHookAdd(dmdest,DMCoarsenHook_DMSNES,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
29922c6f798SBarry Smith   ierr = DMRefineHookAdd(dmdest,DMRefineHook_DMSNES,PETSC_NULL,PETSC_NULL);CHKERRQ(ierr);
300be081cd6SPeter Brune   ierr = DMSubDomainHookAdd(dmdest,DMSubDomainHook_DMSNES,DMSubDomainRestrictHook_DMSNES,PETSC_NULL);CHKERRQ(ierr);
3016cab3a1bSJed Brown   PetscFunctionReturn(0);
3026cab3a1bSJed Brown }
3036cab3a1bSJed Brown 
3046cab3a1bSJed Brown #undef __FUNCT__
3056cab3a1bSJed Brown #define __FUNCT__ "DMSNESSetFunction"
3066cab3a1bSJed Brown /*@C
3076cab3a1bSJed Brown    DMSNESSetFunction - set SNES residual evaluation function
3086cab3a1bSJed Brown 
3096cab3a1bSJed Brown    Not Collective
3106cab3a1bSJed Brown 
3116cab3a1bSJed Brown    Input Arguments:
3126cab3a1bSJed Brown +  dm - DM to be used with SNES
3136cab3a1bSJed Brown .  func - residual evaluation function, see SNESSetFunction() for calling sequence
3146cab3a1bSJed Brown -  ctx - context for residual evaluation
3156cab3a1bSJed Brown 
3166cab3a1bSJed Brown    Level: advanced
3176cab3a1bSJed Brown 
3186cab3a1bSJed Brown    Note:
3196cab3a1bSJed Brown    SNESSetFunction() is normally used, but it calls this function internally because the user context is actually
3206cab3a1bSJed Brown    associated with the DM.  This makes the interface consistent regardless of whether the user interacts with a DM or
3216cab3a1bSJed Brown    not. If DM took a more central role at some later date, this could become the primary method of setting the residual.
3226cab3a1bSJed Brown 
3236cab3a1bSJed Brown .seealso: DMSNESSetContext(), SNESSetFunction(), DMSNESSetJacobian()
3246cab3a1bSJed Brown @*/
3256cab3a1bSJed Brown PetscErrorCode DMSNESSetFunction(DM dm,PetscErrorCode (*func)(SNES,Vec,Vec,void*),void *ctx)
3266cab3a1bSJed Brown {
3276cab3a1bSJed Brown   PetscErrorCode ierr;
328942e3340SBarry Smith   DMSNES         sdm;
3296cab3a1bSJed Brown 
3306cab3a1bSJed Brown   PetscFunctionBegin;
3316cab3a1bSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
332fdaff8d6SPeter Brune   if (func || ctx) {
333942e3340SBarry Smith     ierr = DMGetDMSNESWrite(dm,&sdm);CHKERRQ(ierr);
334fdaff8d6SPeter Brune   }
33522c6f798SBarry Smith   if (func) sdm->ops->computefunction = func;
3366cab3a1bSJed Brown   if (ctx)  sdm->functionctx = ctx;
3376cab3a1bSJed Brown   PetscFunctionReturn(0);
3386cab3a1bSJed Brown }
3396cab3a1bSJed Brown 
3406cab3a1bSJed Brown #undef __FUNCT__
3416cab3a1bSJed Brown #define __FUNCT__ "DMSNESGetFunction"
3426cab3a1bSJed Brown /*@C
3436cab3a1bSJed Brown    DMSNESGetFunction - get SNES residual evaluation function
3446cab3a1bSJed Brown 
3456cab3a1bSJed Brown    Not Collective
3466cab3a1bSJed Brown 
3476cab3a1bSJed Brown    Input Argument:
3486cab3a1bSJed Brown .  dm - DM to be used with SNES
3496cab3a1bSJed Brown 
3506cab3a1bSJed Brown    Output Arguments:
3516cab3a1bSJed Brown +  func - residual evaluation function, see SNESSetFunction() for calling sequence
3526cab3a1bSJed Brown -  ctx - context for residual evaluation
3536cab3a1bSJed Brown 
3546cab3a1bSJed Brown    Level: advanced
3556cab3a1bSJed Brown 
3566cab3a1bSJed Brown    Note:
3576cab3a1bSJed Brown    SNESGetFunction() is normally used, but it calls this function internally because the user context is actually
3586cab3a1bSJed Brown    associated with the DM.
3596cab3a1bSJed Brown 
3606cab3a1bSJed Brown .seealso: DMSNESSetContext(), DMSNESSetFunction(), SNESSetFunction()
3616cab3a1bSJed Brown @*/
3626cab3a1bSJed Brown PetscErrorCode DMSNESGetFunction(DM dm,PetscErrorCode (**func)(SNES,Vec,Vec,void*),void **ctx)
3636cab3a1bSJed Brown {
3646cab3a1bSJed Brown   PetscErrorCode ierr;
365942e3340SBarry Smith   DMSNES         sdm;
3666cab3a1bSJed Brown 
3676cab3a1bSJed Brown   PetscFunctionBegin;
3686cab3a1bSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
369942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
37022c6f798SBarry Smith   if (func) *func = sdm->ops->computefunction;
3716cab3a1bSJed Brown   if (ctx)  *ctx = sdm->functionctx;
3726cab3a1bSJed Brown   PetscFunctionReturn(0);
3736cab3a1bSJed Brown }
3746cab3a1bSJed Brown 
3756cab3a1bSJed Brown #undef __FUNCT__
3762a4ee8f2SPeter Brune #define __FUNCT__ "DMSNESSetObjective"
3772a4ee8f2SPeter Brune /*@C
378081a7dcdSPeter Brune    DMSNESSetObjective - set SNES objective evaluation function
3792a4ee8f2SPeter Brune 
3802a4ee8f2SPeter Brune    Not Collective
3812a4ee8f2SPeter Brune 
3822a4ee8f2SPeter Brune    Input Arguments:
3832a4ee8f2SPeter Brune +  dm - DM to be used with SNES
3842a4ee8f2SPeter Brune .  func - residual evaluation function, see SNESSetObjective() for calling sequence
3852a4ee8f2SPeter Brune -  ctx - context for residual evaluation
3862a4ee8f2SPeter Brune 
3872a4ee8f2SPeter Brune    Level: advanced
3882a4ee8f2SPeter Brune 
3892a4ee8f2SPeter Brune .seealso: DMSNESSetContext(), SNESGetObjective(), DMSNESSetFunction()
3902a4ee8f2SPeter Brune @*/
3912a4ee8f2SPeter Brune PetscErrorCode DMSNESSetObjective(DM dm,SNESObjective func,void *ctx)
3922a4ee8f2SPeter Brune {
3932a4ee8f2SPeter Brune   PetscErrorCode ierr;
394942e3340SBarry Smith   DMSNES         sdm;
3952a4ee8f2SPeter Brune 
3962a4ee8f2SPeter Brune   PetscFunctionBegin;
3972a4ee8f2SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
398fdaff8d6SPeter Brune   if (func || ctx) {
399942e3340SBarry Smith     ierr = DMGetDMSNESWrite(dm,&sdm);CHKERRQ(ierr);
400fdaff8d6SPeter Brune   }
40122c6f798SBarry Smith   if (func) sdm->ops->computeobjective = func;
4022a4ee8f2SPeter Brune   if (ctx)  sdm->objectivectx = ctx;
4032a4ee8f2SPeter Brune   PetscFunctionReturn(0);
4042a4ee8f2SPeter Brune }
4052a4ee8f2SPeter Brune 
4062a4ee8f2SPeter Brune #undef __FUNCT__
4072a4ee8f2SPeter Brune #define __FUNCT__ "DMSNESGetObjective"
4082a4ee8f2SPeter Brune /*@C
4092a4ee8f2SPeter Brune    DMSNESGetObjective - get SNES objective evaluation function
4102a4ee8f2SPeter Brune 
4112a4ee8f2SPeter Brune    Not Collective
4122a4ee8f2SPeter Brune 
4132a4ee8f2SPeter Brune    Input Argument:
4142a4ee8f2SPeter Brune .  dm - DM to be used with SNES
4152a4ee8f2SPeter Brune 
4162a4ee8f2SPeter Brune    Output Arguments:
4172a4ee8f2SPeter Brune +  func - residual evaluation function, see SNESSetObjective() for calling sequence
4182a4ee8f2SPeter Brune -  ctx - context for residual evaluation
4192a4ee8f2SPeter Brune 
4202a4ee8f2SPeter Brune    Level: advanced
4212a4ee8f2SPeter Brune 
4222a4ee8f2SPeter Brune    Note:
4232a4ee8f2SPeter Brune    SNESGetFunction() is normally used, but it calls this function internally because the user context is actually
4242a4ee8f2SPeter Brune    associated with the DM.
4252a4ee8f2SPeter Brune 
4262a4ee8f2SPeter Brune .seealso: DMSNESSetContext(), DMSNESSetObjective(), SNESSetFunction()
4272a4ee8f2SPeter Brune @*/
4282a4ee8f2SPeter Brune PetscErrorCode DMSNESGetObjective(DM dm,SNESObjective *func,void **ctx)
4292a4ee8f2SPeter Brune {
4302a4ee8f2SPeter Brune   PetscErrorCode ierr;
431942e3340SBarry Smith   DMSNES         sdm;
4322a4ee8f2SPeter Brune 
4332a4ee8f2SPeter Brune   PetscFunctionBegin;
4342a4ee8f2SPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
435942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
43622c6f798SBarry Smith   if (func) *func = sdm->ops->computeobjective;
4372a4ee8f2SPeter Brune   if (ctx)  *ctx = sdm->objectivectx;
4382a4ee8f2SPeter Brune   PetscFunctionReturn(0);
4392a4ee8f2SPeter Brune }
4402a4ee8f2SPeter Brune 
4412a4ee8f2SPeter Brune #undef __FUNCT__
4426cab3a1bSJed Brown #define __FUNCT__ "DMSNESSetGS"
4436cab3a1bSJed Brown /*@C
4446cab3a1bSJed Brown    DMSNESSetGS - set SNES Gauss-Seidel relaxation function
4456cab3a1bSJed Brown 
4466cab3a1bSJed Brown    Not Collective
4476cab3a1bSJed Brown 
4486cab3a1bSJed Brown    Input Argument:
4496cab3a1bSJed Brown +  dm - DM to be used with SNES
4506cab3a1bSJed Brown .  func - relaxation function, see SNESSetGS() for calling sequence
4516cab3a1bSJed Brown -  ctx - context for residual evaluation
4526cab3a1bSJed Brown 
4536cab3a1bSJed Brown    Level: advanced
4546cab3a1bSJed Brown 
4556cab3a1bSJed Brown    Note:
4566cab3a1bSJed Brown    SNESSetGS() is normally used, but it calls this function internally because the user context is actually
4576cab3a1bSJed Brown    associated with the DM.  This makes the interface consistent regardless of whether the user interacts with a DM or
4586cab3a1bSJed Brown    not. If DM took a more central role at some later date, this could become the primary method of setting the residual.
4596cab3a1bSJed Brown 
4606cab3a1bSJed Brown .seealso: DMSNESSetContext(), SNESSetFunction(), DMSNESSetJacobian(), DMSNESSetFunction()
4616cab3a1bSJed Brown @*/
4626cab3a1bSJed Brown PetscErrorCode DMSNESSetGS(DM dm,PetscErrorCode (*func)(SNES,Vec,Vec,void*),void *ctx)
4636cab3a1bSJed Brown {
4646cab3a1bSJed Brown   PetscErrorCode ierr;
465942e3340SBarry Smith   DMSNES         sdm;
4666cab3a1bSJed Brown 
4676cab3a1bSJed Brown   PetscFunctionBegin;
4686cab3a1bSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
469fdaff8d6SPeter Brune   if (func || ctx) {
470942e3340SBarry Smith     ierr = DMGetDMSNESWrite(dm,&sdm);CHKERRQ(ierr);
471fdaff8d6SPeter Brune   }
47222c6f798SBarry Smith   if (func) sdm->ops->computegs = func;
4736cab3a1bSJed Brown   if (ctx)  sdm->gsctx = ctx;
4746cab3a1bSJed Brown   PetscFunctionReturn(0);
4756cab3a1bSJed Brown }
4766cab3a1bSJed Brown 
4776cab3a1bSJed Brown #undef __FUNCT__
4786cab3a1bSJed Brown #define __FUNCT__ "DMSNESGetGS"
4796cab3a1bSJed Brown /*@C
4806cab3a1bSJed Brown    DMSNESGetGS - get SNES Gauss-Seidel relaxation function
4816cab3a1bSJed Brown 
4826cab3a1bSJed Brown    Not Collective
4836cab3a1bSJed Brown 
4846cab3a1bSJed Brown    Input Argument:
4856cab3a1bSJed Brown .  dm - DM to be used with SNES
4866cab3a1bSJed Brown 
4876cab3a1bSJed Brown    Output Arguments:
4886cab3a1bSJed Brown +  func - relaxation function, see SNESSetGS() for calling sequence
4896cab3a1bSJed Brown -  ctx - context for residual evaluation
4906cab3a1bSJed Brown 
4916cab3a1bSJed Brown    Level: advanced
4926cab3a1bSJed Brown 
4936cab3a1bSJed Brown    Note:
4946cab3a1bSJed Brown    SNESGetGS() is normally used, but it calls this function internally because the user context is actually
4956cab3a1bSJed Brown    associated with the DM.  This makes the interface consistent regardless of whether the user interacts with a DM or
4966cab3a1bSJed Brown    not. If DM took a more central role at some later date, this could become the primary method of setting the residual.
4976cab3a1bSJed Brown 
4986cab3a1bSJed Brown .seealso: DMSNESSetContext(), SNESGetGS(), DMSNESGetJacobian(), DMSNESGetFunction()
4996cab3a1bSJed Brown @*/
5006cab3a1bSJed Brown PetscErrorCode DMSNESGetGS(DM dm,PetscErrorCode (**func)(SNES,Vec,Vec,void*),void **ctx)
5016cab3a1bSJed Brown {
5026cab3a1bSJed Brown   PetscErrorCode ierr;
503942e3340SBarry Smith   DMSNES         sdm;
5046cab3a1bSJed Brown 
5056cab3a1bSJed Brown   PetscFunctionBegin;
5066cab3a1bSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
507942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
50822c6f798SBarry Smith   if (func) *func = sdm->ops->computegs;
5096cab3a1bSJed Brown   if (ctx)  *ctx = sdm->gsctx;
5106cab3a1bSJed Brown   PetscFunctionReturn(0);
5116cab3a1bSJed Brown }
5126cab3a1bSJed Brown 
5136cab3a1bSJed Brown #undef __FUNCT__
5146cab3a1bSJed Brown #define __FUNCT__ "DMSNESSetJacobian"
5156cab3a1bSJed Brown /*@C
516ecfdb398SPeter Brune    DMSNESSetJacobian - set SNES Jacobian evaluation function
5176cab3a1bSJed Brown 
5186cab3a1bSJed Brown    Not Collective
5196cab3a1bSJed Brown 
5206cab3a1bSJed Brown    Input Argument:
5216cab3a1bSJed Brown +  dm - DM to be used with SNES
5226cab3a1bSJed Brown .  func - Jacobian evaluation function, see SNESSetJacobian() for calling sequence
5236cab3a1bSJed Brown -  ctx - context for residual evaluation
5246cab3a1bSJed Brown 
5256cab3a1bSJed Brown    Level: advanced
5266cab3a1bSJed Brown 
5276cab3a1bSJed Brown    Note:
5286cab3a1bSJed Brown    SNESSetJacobian() is normally used, but it calls this function internally because the user context is actually
5296cab3a1bSJed Brown    associated with the DM.  This makes the interface consistent regardless of whether the user interacts with a DM or
5306cab3a1bSJed Brown    not. If DM took a more central role at some later date, this could become the primary method of setting the Jacobian.
5316cab3a1bSJed Brown 
5326cab3a1bSJed Brown .seealso: DMSNESSetContext(), SNESSetFunction(), DMSNESGetJacobian(), SNESSetJacobian()
5336cab3a1bSJed Brown @*/
5346cab3a1bSJed Brown PetscErrorCode DMSNESSetJacobian(DM dm,PetscErrorCode (*func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
5356cab3a1bSJed Brown {
5366cab3a1bSJed Brown   PetscErrorCode ierr;
537942e3340SBarry Smith   DMSNES         sdm;
5386cab3a1bSJed Brown 
5396cab3a1bSJed Brown   PetscFunctionBegin;
5406cab3a1bSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
5411fdfe764SBarry Smith   if (func || ctx) {
542942e3340SBarry Smith     ierr = DMGetDMSNESWrite(dm,&sdm);CHKERRQ(ierr);
5431fdfe764SBarry Smith   }
54422c6f798SBarry Smith   if (func) sdm->ops->computejacobian = func;
5456cab3a1bSJed Brown   if (ctx)  sdm->jacobianctx = ctx;
5466cab3a1bSJed Brown   PetscFunctionReturn(0);
5476cab3a1bSJed Brown }
5486cab3a1bSJed Brown 
5496cab3a1bSJed Brown #undef __FUNCT__
5506cab3a1bSJed Brown #define __FUNCT__ "DMSNESGetJacobian"
5516cab3a1bSJed Brown /*@C
552ecfdb398SPeter Brune    DMSNESGetJacobian - get SNES Jacobian evaluation function
5536cab3a1bSJed Brown 
5546cab3a1bSJed Brown    Not Collective
5556cab3a1bSJed Brown 
5566cab3a1bSJed Brown    Input Argument:
5576cab3a1bSJed Brown .  dm - DM to be used with SNES
5586cab3a1bSJed Brown 
5596cab3a1bSJed Brown    Output Arguments:
5606cab3a1bSJed Brown +  func - Jacobian evaluation function, see SNESSetJacobian() for calling sequence
5616cab3a1bSJed Brown -  ctx - context for residual evaluation
5626cab3a1bSJed Brown 
5636cab3a1bSJed Brown    Level: advanced
5646cab3a1bSJed Brown 
5656cab3a1bSJed Brown    Note:
5666cab3a1bSJed Brown    SNESGetJacobian() is normally used, but it calls this function internally because the user context is actually
5676cab3a1bSJed Brown    associated with the DM.  This makes the interface consistent regardless of whether the user interacts with a DM or
5686cab3a1bSJed Brown    not. If DM took a more central role at some later date, this could become the primary method of setting the Jacobian.
5696cab3a1bSJed Brown 
5706cab3a1bSJed Brown .seealso: DMSNESSetContext(), SNESSetFunction(), DMSNESSetJacobian()
5716cab3a1bSJed Brown @*/
5726cab3a1bSJed Brown PetscErrorCode DMSNESGetJacobian(DM dm,PetscErrorCode (**func)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
5736cab3a1bSJed Brown {
5746cab3a1bSJed Brown   PetscErrorCode ierr;
575942e3340SBarry Smith   DMSNES         sdm;
5766cab3a1bSJed Brown 
5776cab3a1bSJed Brown   PetscFunctionBegin;
5786cab3a1bSJed Brown   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
579942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
58022c6f798SBarry Smith   if (func) *func = sdm->ops->computejacobian;
5816cab3a1bSJed Brown   if (ctx)  *ctx = sdm->jacobianctx;
5826cab3a1bSJed Brown   PetscFunctionReturn(0);
5836cab3a1bSJed Brown }
5846cab3a1bSJed Brown 
5856cab3a1bSJed Brown #undef __FUNCT__
586e03ab78fSPeter Brune #define __FUNCT__ "DMSNESSetPicard"
587e03ab78fSPeter Brune /*@C
588e03ab78fSPeter Brune    DMSNESSetPicard - set SNES Picard iteration matrix and RHS evaluation functions.
589e03ab78fSPeter Brune 
590e03ab78fSPeter Brune    Not Collective
591e03ab78fSPeter Brune 
592e03ab78fSPeter Brune    Input Argument:
593e03ab78fSPeter Brune +  dm - DM to be used with SNES
594e03ab78fSPeter Brune .  func - RHS evaluation function, see SNESSetFunction() for calling sequence
595e03ab78fSPeter Brune .  pjac - Picard matrix evaluation function, see SNESSetJacobian() for calling sequence
596e03ab78fSPeter Brune -  ctx - context for residual evaluation
597e03ab78fSPeter Brune 
598e03ab78fSPeter Brune    Level: advanced
599e03ab78fSPeter Brune 
600e03ab78fSPeter Brune .seealso: SNESSetPicard(), DMSNESSetFunction(), DMSNESSetJacobian()
601e03ab78fSPeter Brune @*/
602e03ab78fSPeter Brune PetscErrorCode DMSNESSetPicard(DM dm,PetscErrorCode (*pfunc)(SNES,Vec,Vec,void*),PetscErrorCode (*pjac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void *ctx)
603e03ab78fSPeter Brune {
604e03ab78fSPeter Brune   PetscErrorCode ierr;
605942e3340SBarry Smith   DMSNES         sdm;
606e03ab78fSPeter Brune 
607e03ab78fSPeter Brune   PetscFunctionBegin;
608e03ab78fSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
609942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
61022c6f798SBarry Smith   if (pfunc) sdm->ops->computepfunction = pfunc;
61122c6f798SBarry Smith   if (pjac)  sdm->ops->computepjacobian = pjac;
612e03ab78fSPeter Brune   if (ctx)   sdm->pctx             = ctx;
613e03ab78fSPeter Brune   PetscFunctionReturn(0);
614e03ab78fSPeter Brune }
615e03ab78fSPeter Brune 
6167971a8bfSPeter Brune 
6177971a8bfSPeter Brune #undef __FUNCT__
6187971a8bfSPeter Brune #define __FUNCT__ "DMSNESGetPicard"
6197971a8bfSPeter Brune /*@C
6207971a8bfSPeter Brune    DMSNESGetPicard - get SNES Picard iteration evaluation functions
6217971a8bfSPeter Brune 
6227971a8bfSPeter Brune    Not Collective
6237971a8bfSPeter Brune 
6247971a8bfSPeter Brune    Input Argument:
6257971a8bfSPeter Brune .  dm - DM to be used with SNES
6267971a8bfSPeter Brune 
6277971a8bfSPeter Brune    Output Arguments:
6287971a8bfSPeter Brune +  pfunc - Jacobian evaluation function, see SNESSetJacobian() for calling sequence
6297971a8bfSPeter Brune .  pjac  - RHS evaluation function, see SNESSetFunction() for calling sequence
6307971a8bfSPeter Brune -  ctx - context for residual evaluation
6317971a8bfSPeter Brune 
6327971a8bfSPeter Brune    Level: advanced
6337971a8bfSPeter Brune 
6347971a8bfSPeter Brune .seealso: DMSNESSetContext(), SNESSetFunction(), DMSNESSetJacobian()
6357971a8bfSPeter Brune @*/
6367971a8bfSPeter Brune PetscErrorCode DMSNESGetPicard(DM dm,PetscErrorCode (**pfunc)(SNES,Vec,Vec,void*),PetscErrorCode (**pjac)(SNES,Vec,Mat*,Mat*,MatStructure*,void*),void **ctx)
6377971a8bfSPeter Brune {
6387971a8bfSPeter Brune   PetscErrorCode ierr;
639942e3340SBarry Smith   DMSNES         sdm;
6407971a8bfSPeter Brune 
6417971a8bfSPeter Brune   PetscFunctionBegin;
6427971a8bfSPeter Brune   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
643942e3340SBarry Smith   ierr = DMGetDMSNES(dm,&sdm);CHKERRQ(ierr);
64422c6f798SBarry Smith   if (pfunc) *pfunc = sdm->ops->computepfunction;
64522c6f798SBarry Smith   if (pjac) *pjac   = sdm->ops->computepjacobian;
6467971a8bfSPeter Brune   if (ctx)  *ctx    = sdm->pctx;
6477971a8bfSPeter Brune   PetscFunctionReturn(0);
6487971a8bfSPeter Brune }
649