15c6c1daeSBarry Smith 2af0996ceSBarry Smith #include <petsc/private/viewerimpl.h> /*I "petscsys.h" */ 3e04113cfSBarry Smith #include <petscviewersaws.h> 45c6c1daeSBarry Smith 55c6c1daeSBarry Smith /*@C 6d45a07a7SBarry Smith PetscViewerSAWsOpen - Opens an SAWs PetscViewer. 75c6c1daeSBarry Smith 8d083f849SBarry Smith Collective 95c6c1daeSBarry Smith 105c6c1daeSBarry Smith Input Parameters: 11ec957eceSBarry Smith . comm - the MPI communicator 125c6c1daeSBarry Smith 135c6c1daeSBarry Smith Output Parameter: 145c6c1daeSBarry Smith . lab - the PetscViewer 155c6c1daeSBarry Smith 165c6c1daeSBarry Smith Options Database Keys: 17f7b25cf6SBarry Smith + -saws_port <port number> - port number where you are running SAWs client 18f7b25cf6SBarry Smith . -xxx_view saws - publish the object xxx 19e04113cfSBarry Smith - -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 20f7b25cf6SBarry Smith the user unblocks the problem with an external tool that access the object with SAWS 215c6c1daeSBarry Smith 225c6c1daeSBarry Smith Level: advanced 235c6c1daeSBarry Smith 245c6c1daeSBarry Smith Fortran Note: 255c6c1daeSBarry Smith This routine is not supported in Fortran. 265c6c1daeSBarry Smith 275c6c1daeSBarry Smith Notes: 28e04113cfSBarry Smith Unlike other viewers that only access the object being viewed on the call to XXXView(object,viewer) the SAWs viewer allows 29e04113cfSBarry Smith one to view the object asynchronously as the program continues to run. One can remove SAWs access to the object with a call to 30e04113cfSBarry Smith PetscObjectSAWsViewOff(). 3138dc1537SBarry Smith 32a8d69d7bSBarry Smith Information about the SAWs is available via https://bitbucket.org/saws/saws 335c6c1daeSBarry Smith 34e04113cfSBarry Smith .seealso: PetscViewerDestroy(), PetscViewerStringSPrintf(), PETSC_VIEWER_SAWS_(), PetscObjectSAWsBlock(), 35e04113cfSBarry Smith PetscObjectSAWsViewOff(), PetscObjectSAWsTakeAccess(), PetscObjectSAWsGrantAccess() 365c6c1daeSBarry Smith 375c6c1daeSBarry Smith @*/ 38e04113cfSBarry Smith PetscErrorCode PetscViewerSAWsOpen(MPI_Comm comm,PetscViewer *lab) 395c6c1daeSBarry Smith { 405c6c1daeSBarry Smith PetscFunctionBegin; 41*5f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerCreate(comm,lab)); 42*5f80ce2aSJacob Faibussowitsch CHKERRQ(PetscViewerSetType(*lab,PETSCVIEWERSAWS)); 435c6c1daeSBarry Smith PetscFunctionReturn(0); 445c6c1daeSBarry Smith } 45bfb97211SBarry Smith 46bfb97211SBarry Smith /*@C 47e04113cfSBarry Smith PetscObjectViewSAWs - View the base portion of any object with an SAWs viewer 48bfb97211SBarry Smith 49bfb97211SBarry Smith Collective on PetscObject 50bfb97211SBarry Smith 51bfb97211SBarry Smith Input Parameters: 52bfb97211SBarry Smith + obj - the Petsc variable 53bfb97211SBarry Smith Thus must be cast with a (PetscObject), for example, 54bfb97211SBarry Smith PetscObjectSetName((PetscObject)mat,name); 55e04113cfSBarry Smith - viewer - the SAWs viewer 56bfb97211SBarry Smith 57bfb97211SBarry Smith Level: advanced 58bfb97211SBarry Smith 59d45a07a7SBarry Smith Developer Note: Currently this is called only on rank zero of PETSC_COMM_WORLD 60d45a07a7SBarry Smith 61d45a07a7SBarry Smith The object must have already been named before calling this routine since naming an 62d45a07a7SBarry Smith object can be collective. 63d45a07a7SBarry Smith 64e04113cfSBarry Smith .seealso: PetscObjectSetName(), PetscObjectSAWsViewOff() 65bfb97211SBarry Smith 66bfb97211SBarry Smith @*/ 67e04113cfSBarry Smith PetscErrorCode PetscObjectViewSAWs(PetscObject obj,PetscViewer viewer) 68bfb97211SBarry Smith { 692657e9d9SBarry Smith char dir[1024]; 70d45a07a7SBarry Smith PetscMPIInt rank; 71bfb97211SBarry Smith 72bfb97211SBarry Smith PetscFunctionBegin; 73bfb97211SBarry Smith PetscValidHeader(obj,1); 74ec957eceSBarry Smith if (obj->amsmem) PetscFunctionReturn(0); 75*5f80ce2aSJacob Faibussowitsch CHKERRMPI(MPI_Comm_rank(PETSC_COMM_WORLD,&rank)); 76*5f80ce2aSJacob Faibussowitsch PetscCheck(!rank,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Should only be being called on rank zero"); 77*5f80ce2aSJacob Faibussowitsch PetscCheck(obj->name,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Object must already have been named"); 78bfb97211SBarry Smith 7956f85f32SBarry Smith obj->amsmem = PETSC_TRUE; 80*5f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/Class",obj->name)); 812657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&obj->class_name,1,SAWs_READ,SAWs_STRING)); 82*5f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/Type",obj->name)); 832657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&obj->type_name,1,SAWs_READ,SAWs_STRING)); 84*5f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/__Id",obj->name)); 852657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&obj->id,1,SAWs_READ,SAWs_INT)); 86*5f80ce2aSJacob Faibussowitsch CHKERRQ(PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/__ParentID",obj->name)); 872657e9d9SBarry Smith PetscStackCallSAWs(SAWs_Register,(dir,&obj->parentid,1,SAWs_READ,SAWs_INT)); 88bfb97211SBarry Smith PetscFunctionReturn(0); 89bfb97211SBarry Smith } 90