PetscSmartObj.hpp File Reference

Petsc smart obj declarations. More...

Go to the source code of this file.

Classes
struct	MoFEM::SmartPetscObj< OBJ >
	intrusive_ptr for managing petsc objects More...

Namespaces
namespace	MoFEM
	implementation of Data Operators for Forces and Sources

Functions
template<typename T >
PetscObject	MoFEM::getPetscObject (T obj)
template<typename OBJ >
void	intrusive_ptr_add_ref (OBJ obj)
	It is used by intrusive_ptr to bump reference. More...
template<typename OBJ >
void	intrusive_ptr_release (OBJ obj)
	It is used by intrusive_ptr to dereference and destroy petsc object. More...
template<>
void	intrusive_ptr_release< Vec > (Vec obj)
template<>
void	intrusive_ptr_release< Mat > (Mat obj)
template<>
void	intrusive_ptr_release< DM > (DM obj)
template<>
void	intrusive_ptr_release< IS > (IS obj)
template<>
void	intrusive_ptr_release< AO > (AO obj)
template<>
void	intrusive_ptr_release< KSP > (KSP obj)
template<>
void	intrusive_ptr_release< SNES > (SNES obj)
template<>
void	intrusive_ptr_release< TS > (TS obj)
auto	MoFEM::createDM (MPI_Comm comm, const std::string dm_type_name)
	Creates smart DM object. More...
DEPRECATED auto	MoFEM::createSmartDM (MPI_Comm comm, const std::string dm_type_name)
MPI_Comm	MoFEM::getCommFromPetscObject (PetscObject obj)
	Get the Comm From Petsc Object object. More...
auto	MoFEM::createGhostVector (MPI_Comm comm, PetscInt n, PetscInt N, PetscInt nghost, const PetscInt ghosts[])
	Create smart ghost vector. More...
DEPRECATED auto	MoFEM::createSmartGhostVector (MPI_Comm comm, PetscInt n, PetscInt N, PetscInt nghost, const PetscInt ghosts[])
auto	MoFEM::createVectorMPI (MPI_Comm comm, PetscInt n, PetscInt N)
	Create MPI Vector. More...
DEPRECATED auto	MoFEM::createSmartVectorMPI (MPI_Comm comm, PetscInt n, PetscInt N)
SmartPetscObj< Vec >	MoFEM::vectorDuplicate (Vec vec)
	Create duplicate vector of smart vector. More...
DEPRECATED SmartPetscObj< Vec >	MoFEM::smartVectorDuplicate (Vec vec)
SmartPetscObj< Mat >	MoFEM::matDuplicate (Mat mat, MatDuplicateOption op)
DEPRECATED SmartPetscObj< Mat >	MoFEM::smartMatDuplicate (Mat mat, MatDuplicateOption op)
auto	MoFEM::createTS (MPI_Comm comm)
auto	MoFEM::createSNES (MPI_Comm comm)
auto	MoFEM::createKSP (MPI_Comm comm)
auto	MoFEM::createPC (MPI_Comm comm)
auto	MoFEM::createISGeneral (MPI_Comm comm, PetscInt n, const PetscInt idx[], PetscCopyMode mode)
	Creates a data structure for an index set containing a list of integers. More...
auto	MoFEM::createAOMappingIS (IS isapp, IS ispetsc)
	Creates an application mapping using two index sets. More...
auto	MoFEM::createAOMapping (MPI_Comm comm, PetscInt napp, const PetscInt myapp[], const PetscInt mypetsc[])
	Creates an application mapping using two integer arrays. More...
auto	MoFEM::createVecScatter (Vec x, IS ix, Vec y, IS iy)
	Create a Vec Scatter object. More...

Detailed Description

Petsc smart obj declarations.

Definition in file PetscSmartObj.hpp.

Function Documentation

intrusive_ptr_add_ref()

template<typename OBJ >

void intrusive_ptr_add_ref

(

OBJ

obj

)

It is used by intrusive_ptr to bump reference.

Note

It should not be used directly, it is internally called by intrusive_ptr

Template Parameters

OBJ

Parameters

obj

Definition at line 23 of file PetscSmartObj.hpp.

                                                            {
  PetscErrorCode ierr = PetscObjectReference(MoFEM::getPetscObject(obj));
  CHKERRABORT(PetscObjectComm(MoFEM::getPetscObject(obj)), ierr);
}

intrusive_ptr_release()

template<typename OBJ >

void intrusive_ptr_release

(

OBJ

obj

)

It is used by intrusive_ptr to dereference and destroy petsc object.

Note

It should not be used directly, it is internally called by intrusive_ptr

Template Parameters

OBJ

Parameters

obj

Definition at line 37 of file PetscSmartObj.hpp.

                                                            {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      if (cnt > 1) {
        ierr = PetscObjectDereference(MoFEM::getPetscObject(obj));
      } else {
        ierr = PetscObjectDestroy(reinterpret_cast<PetscObject *>(&obj));
      }
    }
    auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
    CHKERRABORT(comm, ierr);
  }
}

intrusive_ptr_release< AO >()

template<>

void intrusive_ptr_release< AO >

(

AO

obj

)

Definition at line 55 of file PetscSmartObj.cpp.

                                                   {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      ierr = AODestroy(&obj);
      auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
      CHKERRABORT(comm, ierr);
    }
  }
}

intrusive_ptr_release< DM >()

template<>

void intrusive_ptr_release< DM >

(

DM

obj

)

Definition at line 29 of file PetscSmartObj.cpp.

                                                   {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      ierr = DMDestroy(&obj);
      auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
      CHKERRABORT(comm, ierr);
    }
  }
}

intrusive_ptr_release< IS >()

template<>

void intrusive_ptr_release< IS >

(

IS

obj

)

Definition at line 42 of file PetscSmartObj.cpp.

                                                   {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      ierr = ISDestroy(&obj);
      auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
      CHKERRABORT(comm, ierr);
    }
  }
}

intrusive_ptr_release< KSP >()

template<>

void intrusive_ptr_release< KSP >

(

KSP

obj

)

Definition at line 68 of file PetscSmartObj.cpp.

                                                     {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      ierr = KSPDestroy(&obj);
      auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
      CHKERRABORT(comm, ierr);
    }
  }
}

intrusive_ptr_release< Mat >()

template<>

void intrusive_ptr_release< Mat >

(

Mat

obj

)

Definition at line 16 of file PetscSmartObj.cpp.

                                                     {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      ierr = MatDestroy(&obj);
      auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
      CHKERRABORT(comm, ierr);
    }
  }
}

intrusive_ptr_release< SNES >()

template<>

void intrusive_ptr_release< SNES >

(

SNES

obj

)

Definition at line 81 of file PetscSmartObj.cpp.

                                                       {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      ierr = SNESDestroy(&obj);
      auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
      CHKERRABORT(comm, ierr);
    }
  }
}

intrusive_ptr_release< TS >()

template<>

void intrusive_ptr_release< TS >

(

TS

obj

)

Definition at line 94 of file PetscSmartObj.cpp.

                                                   {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      ierr = TSDestroy(&obj);
      auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
      CHKERRABORT(comm, ierr);
    }
  }
}

intrusive_ptr_release< Vec >()

template<>

void intrusive_ptr_release< Vec >

(

Vec

obj

)

Definition at line 3 of file PetscSmartObj.cpp.

                                                     {
  int cnt = 0;
  PetscErrorCode ierr =
      PetscObjectGetReference(MoFEM::getPetscObject(obj), &cnt);
  if (!ierr) {
    if (cnt) {
      ierr = VecDestroy(&obj);
      auto comm = PetscObjectComm(MoFEM::getPetscObject(obj));
      CHKERRABORT(comm, ierr);
    }
  }
}