Actual source code: amsopen.c
2: #include <petsc/private/viewerimpl.h>
3: #include <petscviewersaws.h>
5: /*@C
6: PetscViewerSAWsOpen - Opens an SAWs PetscViewer.
8: Collective
10: Input Parameters:
11: . comm - the MPI communicator
13: Output Parameter:
14: . lab - the PetscViewer
16: Options Database Keys:
17: + -saws_port <port number> - port number where you are running SAWs client
18: . -xxx_view saws - publish the object xxx
19: - -xxx_saws_block - blocks the program at the end of a critical point (for KSP and SNES it is the end of a solve) until
20: the user unblocks the problem with an external tool that access the object with SAWS
22: Level: advanced
24: Fortran Note:
25: This routine is not supported in Fortran.
27: Notes:
28: Unlike other viewers that only access the object being viewed on the call to XXXView(object,viewer) the SAWs viewer allows
29: one to view the object asynchronously as the program continues to run. One can remove SAWs access to the object with a call to
30: PetscObjectSAWsViewOff().
32: Information about the SAWs is available via https://bitbucket.org/saws/saws
34: .seealso: PetscViewerDestroy(), PetscViewerStringSPrintf(), PETSC_VIEWER_SAWS_(), PetscObjectSAWsBlock(),
35: PetscObjectSAWsViewOff(), PetscObjectSAWsTakeAccess(), PetscObjectSAWsGrantAccess()
37: @*/
38: PetscErrorCode PetscViewerSAWsOpen(MPI_Comm comm,PetscViewer *lab)
39: {
43: PetscViewerCreate(comm,lab);
44: PetscViewerSetType(*lab,PETSCVIEWERSAWS);
45: return(0);
46: }
48: /*@C
49: PetscObjectViewSAWs - View the base portion of any object with an SAWs viewer
51: Collective on PetscObject
53: Input Parameters:
54: + obj - the Petsc variable
55: Thus must be cast with a (PetscObject), for example,
56: PetscObjectSetName((PetscObject)mat,name);
57: - viewer - the SAWs viewer
59: Level: advanced
61: Developer Note: Currently this is called only on rank zero of PETSC_COMM_WORLD
63: The object must have already been named before calling this routine since naming an
64: object can be collective.
66: .seealso: PetscObjectSetName(), PetscObjectSAWsViewOff()
68: @*/
69: PetscErrorCode PetscObjectViewSAWs(PetscObject obj,PetscViewer viewer)
70: {
72: char dir[1024];
73: PetscMPIInt rank;
77: if (obj->amsmem) return(0);
78: MPI_Comm_rank(PETSC_COMM_WORLD,&rank);
79: if (rank) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Should only be being called on rank zero");
80: if (!obj->name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Object must already have been named");
82: obj->amsmem = PETSC_TRUE;
83: PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/Class",obj->name);
84: PetscStackCallSAWs(SAWs_Register,(dir,&obj->class_name,1,SAWs_READ,SAWs_STRING));
85: PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/Type",obj->name);
86: PetscStackCallSAWs(SAWs_Register,(dir,&obj->type_name,1,SAWs_READ,SAWs_STRING));
87: PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/__Id",obj->name);
88: PetscStackCallSAWs(SAWs_Register,(dir,&obj->id,1,SAWs_READ,SAWs_INT));
89: PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/__ParentID",obj->name);
90: PetscStackCallSAWs(SAWs_Register,(dir,&obj->parentid,1,SAWs_READ,SAWs_INT));
91: return(0);
92: }