xref: /petsc/src/sys/classes/viewer/interface/dupl.c (revision 95452b02e12c0ee11232c7ff2b24b568a8e07e43)
15c6c1daeSBarry Smith 
2af0996ceSBarry Smith #include <petsc/private/viewerimpl.h>  /*I "petscviewer.h" I*/
35c6c1daeSBarry Smith 
4b3fa1ec5SBarry Smith /*@C
53f08860eSBarry Smith    PetscViewerGetSubViewer - Creates a new PetscViewer (same type as the old)
63f08860eSBarry Smith     that lives on a subcommunicator
75c6c1daeSBarry Smith 
85c6c1daeSBarry Smith     Collective on PetscViewer
95c6c1daeSBarry Smith 
105c6c1daeSBarry Smith    Input Parameter:
113f08860eSBarry Smith .  viewer - the PetscViewer to be reproduced
125c6c1daeSBarry Smith 
135c6c1daeSBarry Smith    Output Parameter:
145c6c1daeSBarry Smith .  outviewer - new PetscViewer
155c6c1daeSBarry Smith 
165c6c1daeSBarry Smith    Level: advanced
175c6c1daeSBarry Smith 
18*95452b02SPatrick Sanan    Notes:
19*95452b02SPatrick Sanan     Call PetscViewerRestoreSubViewer() to return this PetscViewer, NOT PetscViewerDestroy()
205c6c1daeSBarry Smith 
215c6c1daeSBarry Smith      This is most commonly used to view a sequential object that is part of a
225c6c1daeSBarry Smith     parallel object. For example block Jacobi PC view could use this to obtain a
235c6c1daeSBarry Smith     PetscViewer that is used with the sequential KSP on one block of the preconditioner.
245c6c1daeSBarry Smith 
255c6c1daeSBarry Smith    Concepts: PetscViewer^sequential version
265c6c1daeSBarry Smith 
273f08860eSBarry Smith .seealso: PetscViewerSocketOpen(), PetscViewerASCIIOpen(), PetscViewerDrawOpen(), PetscViewerRestoreSubViewer()
285c6c1daeSBarry Smith @*/
293f08860eSBarry Smith PetscErrorCode  PetscViewerGetSubViewer(PetscViewer viewer,MPI_Comm comm,PetscViewer *outviewer)
305c6c1daeSBarry Smith {
315c6c1daeSBarry Smith   PetscErrorCode ierr;
325c6c1daeSBarry Smith   PetscMPIInt    size;
335c6c1daeSBarry Smith 
345c6c1daeSBarry Smith   PetscFunctionBegin;
355c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
365c6c1daeSBarry Smith   PetscValidPointer(outviewer,2);
37ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)viewer),&size);CHKERRQ(ierr);
385c6c1daeSBarry Smith   if (size == 1) {
395c6c1daeSBarry Smith     ierr       = PetscObjectReference((PetscObject)viewer);CHKERRQ(ierr);
405c6c1daeSBarry Smith     *outviewer = viewer;
41559f443fSBarry Smith   } else if (viewer->ops->getsubviewer) {
42559f443fSBarry Smith     ierr = (*viewer->ops->getsubviewer)(viewer,comm,outviewer);CHKERRQ(ierr);
433f08860eSBarry Smith   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot get SubViewer PetscViewer for type %s",((PetscObject)viewer)->type_name);
441575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
455c6c1daeSBarry Smith   PetscFunctionReturn(0);
465c6c1daeSBarry Smith }
475c6c1daeSBarry Smith 
48b3fa1ec5SBarry Smith /*@C
493f08860eSBarry Smith    PetscViewerRestoreSubViewer - Restores a new PetscViewer obtained with PetscViewerGetSubViewer().
505c6c1daeSBarry Smith 
515c6c1daeSBarry Smith     Collective on PetscViewer
525c6c1daeSBarry Smith 
535c6c1daeSBarry Smith    Input Parameters:
543f08860eSBarry Smith +  viewer - the PetscViewer that was reproduced
555c6c1daeSBarry Smith -  outviewer - new PetscViewer
565c6c1daeSBarry Smith 
575c6c1daeSBarry Smith    Level: advanced
585c6c1daeSBarry Smith 
59*95452b02SPatrick Sanan    Notes:
60*95452b02SPatrick Sanan     Call PetscViewerGetSubViewer() to get this PetscViewer, NOT PetscViewerCreate()
615c6c1daeSBarry Smith 
623f08860eSBarry Smith .seealso: PetscViewerSocketOpen(), PetscViewerASCIIOpen(), PetscViewerDrawOpen(), PetscViewerGetSubViewer()
635c6c1daeSBarry Smith @*/
643f08860eSBarry Smith PetscErrorCode  PetscViewerRestoreSubViewer(PetscViewer viewer,MPI_Comm comm,PetscViewer *outviewer)
655c6c1daeSBarry Smith {
665c6c1daeSBarry Smith   PetscErrorCode ierr;
675c6c1daeSBarry Smith   PetscMPIInt    size;
685c6c1daeSBarry Smith 
695c6c1daeSBarry Smith   PetscFunctionBegin;
705c6c1daeSBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,1);
715c6c1daeSBarry Smith 
72ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)viewer),&size);CHKERRQ(ierr);
735c6c1daeSBarry Smith   if (size == 1) {
745c6c1daeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
75c6228bbaSLisandro Dalcin     if (outviewer) *outviewer = NULL;
76559f443fSBarry Smith   } else if (viewer->ops->restoresubviewer) {
77559f443fSBarry Smith     ierr = (*viewer->ops->restoresubviewer)(viewer,comm,outviewer);CHKERRQ(ierr);
785c6c1daeSBarry Smith   }
791575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
805c6c1daeSBarry Smith   PetscFunctionReturn(0);
815c6c1daeSBarry Smith }
825c6c1daeSBarry Smith 
83