MoFEM::SmartPetscObj< OBJ > Struct Template Reference

intrusive_ptr for managing petsc objects More...

#include <include/PetscSmartObj.hpp>

Inheritance diagram for MoFEM::SmartPetscObj< OBJ >:

Collaboration diagram for MoFEM::SmartPetscObj< OBJ >:

Public Types
using	Derived = boost::intrusive_ptr< typename std::remove_pointer< OBJ >::type >

Public Member Functions
	SmartPetscObj (std::nullptr_t ptr)
	SmartPetscObj (OBJ o, bool add_ref=false)
	Construct a new Smart Petsc Obj object. More...
	operator OBJ ()
	operator PetscObject ()
int	use_count () const

Detailed Description

template<typename OBJ>
struct MoFEM::SmartPetscObj< OBJ >

intrusive_ptr for managing petsc objects

It manages destruction, referencing and dereferencing petsc objects. It is similar how smart_ptr pointers works, but applied for petsc objects like Vec, DM, Mat, etc.

SmartPetscObj<Vec> smart_vec = createSmartGhostVector(...);

Template Parameters

OBJ

Examples

EshelbianOperators.cpp, EshelbianPlasticity.cpp, HookeElement.cpp, approx_sphere.cpp, build_large_problem.cpp, child_and_parent.cpp, contact.cpp, dm_build_partitioned_mesh.cpp, eigen_elastic.cpp, elasticity.cpp, ep.cpp, free_surface.cpp, hanging_node_approx.cpp, heat_equation.cpp, higher_derivatives.cpp, mixed_poisson.cpp, navier_stokes.cpp, nonlinear_elastic.cpp, petsc_smart_ptr_objects.cpp, photon_diffusion.cpp, plastic.cpp, prism_polynomial_approximation.cpp, quad_polynomial_approximation.cpp, reaction_diffusion.cpp, remove_entities_from_problem_not_partitioned.cpp, shallow_wave.cpp, simple_contact.cpp, simple_contact_thermal.cpp, test_cache_on_entities.cpp, test_jacobian_of_simple_contact_element.cpp, and wave_equation.cpp.

Definition at line 80 of file PetscSmartObj.hpp.

Member Typedef Documentation

Derived

template<typename OBJ >

using MoFEM::SmartPetscObj< OBJ >::Derived = boost::intrusive_ptr<typename std::remove_pointer<OBJ>::type>

Definition at line 83 of file PetscSmartObj.hpp.

Constructor & Destructor Documentation

SmartPetscObj() [1/2]

template<typename OBJ >

MoFEM::SmartPetscObj< OBJ >::SmartPetscObj ( std::nullptr_t  ptr )

inline

Definition at line 87 of file PetscSmartObj.hpp.

: SmartPetscObj() {}

SmartPetscObj() [2/2]

template<typename OBJ >

MoFEM::SmartPetscObj< OBJ >::SmartPetscObj ( OBJ  o, bool  add_ref = false  )

inlineexplicit

Construct a new Smart Petsc Obj object.

Note

If add_red is set to true, you have to destroy OBJ.

Parameters

o
add_ref	// if false ownership of OBJ is taken by SmartPetscObj

Definition at line 97 of file PetscSmartObj.hpp.

      : boost::intrusive_ptr<typename std::remove_pointer<OBJ>::type>(o,
                                                                      add_ref) {
  }

Member Function Documentation

operator OBJ()

template<typename OBJ >

MoFEM::SmartPetscObj< OBJ >::operator OBJ ( )

inline

Definition at line 102 of file PetscSmartObj.hpp.

{ return this->get(); }

operator PetscObject()

template<typename OBJ >

MoFEM::SmartPetscObj< OBJ >::operator PetscObject ( )

inlineexplicit

Definition at line 103 of file PetscSmartObj.hpp.

                                  {
    return reinterpret_cast<PetscObject>(this->get());
  }

use_count()

template<typename OBJ >

int MoFEM::SmartPetscObj< OBJ >::use_count ( ) const

inline

Examples

petsc_smart_ptr_objects.cpp.

Definition at line 107 of file PetscSmartObj.hpp.

                        {
    if (this->get()) {
      int cnt;
      ierr = PetscObjectGetReference(getPetscObject(this->get()), &cnt);
      CHKERRABORT(PetscObjectComm(getPetscObject(this->get())), ierr);
      return cnt;
    } else
      return 0;
  }

---

The documentation for this struct was generated from the following file:

• include/PetscSmartObj.hpp