MoFEM::VecManager Struct Reference

Vector manager is used to create vectors \mofem_vectors. More...

#include "src/interfaces/VecManager.hpp"

Inheritance diagram for MoFEM::VecManager:

Collaboration diagram for MoFEM::VecManager:

Public Member Functions
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
	VecManager (const MoFEM::Core &core)
	~VecManager ()=default
MoFEMErrorCode	vecCreateSeq (const std::string name, RowColData rc, Vec *V) const
	create local vector for problem
MoFEMErrorCode	vecCreateGhost (const std::string name, RowColData rc, Vec *V) const
	create ghost vector for problem (collective)
MoFEMErrorCode	vecCreateGhost (const std::string name, RowColData rc, SmartPetscObj< Vec > &v_ptr) const
	create ghost vector for problem (collective)
MoFEMErrorCode	vecScatterCreate (Vec xin, const std::string x_problem, const std::string x_field_name, RowColData x_rc, Vec yin, const std::string y_problem, const std::string y_field_name, RowColData y_rc, VecScatter *newctx) const
	create scatter for vectors from one to another problem (collective)
MoFEMErrorCode	vecScatterCreate (Vec xin, const std::string x_problem, const std::string x_field_name, RowColData x_rc, Vec yin, const std::string y_problem, const std::string y_field_name, RowColData y_rc, SmartPetscObj< VecScatter > &smart_newctx) const
	create scatter for vectors from one to another problem (collective)
MoFEMErrorCode	vecScatterCreate (Vec xin, const std::string x_problem, RowColData x_rc, Vec yin, const std::string y_problem, RowColData y_rc, VecScatter *newctx) const
	create scatter for vectors from one to another problem (collective)
MoFEMErrorCode	vecScatterCreate (Vec xin, const std::string x_problem, RowColData x_rc, Vec yin, const std::string y_problem, RowColData y_rc, SmartPetscObj< VecScatter > &smart_newctx) const
	create scatter for vectors from one to another problem (collective)
MoFEMErrorCode	setLocalGhostVector (const Problem *problem_ptr, RowColData rc, Vec V, InsertMode mode, ScatterMode scatter_mode) const
	set values of vector from/to mesh database
MoFEMErrorCode	setLocalGhostVector (const std::string name, RowColData rc, Vec V, InsertMode mode, ScatterMode scatter_mode) const
	set values of vector from/to mesh database
MoFEMErrorCode	setGlobalGhostVector (const Problem *problem_ptr, RowColData rc, Vec V, InsertMode mode, ScatterMode scatter_mode) const
MoFEMErrorCode	setGlobalGhostVector (const std::string name, RowColData rc, Vec V, InsertMode mode, ScatterMode scatter_mode) const
MoFEMErrorCode	setOtherLocalGhostVector (const Problem *problem_ptr, const std::string field_name, const std::string cpy_field_name, RowColData rc, Vec V, InsertMode mode, ScatterMode scatter_mode) const
	Copy vector to field which is not part of the problem.
MoFEMErrorCode	setOtherLocalGhostVector (const std::string name, const std::string field_name, const std::string cpy_field_name, RowColData rc, Vec V, InsertMode mode, ScatterMode scatter_mode) const
	Copy vector to field which is not part of the problem.
MoFEMErrorCode	setOtherGlobalGhostVector (const Problem *problem_ptr, const std::string field_name, const std::string cpy_field_name, RowColData rc, Vec V, InsertMode mode, ScatterMode scatter_mode) const
	Copy vector to field which is not part of the problem (collective)
MoFEMErrorCode	setOtherGlobalGhostVector (const std::string name, const std::string field_name, const std::string cpy_field_name, RowColData rc, Vec V, InsertMode mode, ScatterMode scatter_mode) const
	Copy vector to field which is not part of the problem (collective)
Public Member Functions inherited from MoFEM::UnknownInterface
template<class IFACE >
MoFEMErrorCode	registerInterface (bool error_if_registration_failed=true)
	Register interface.
template<class IFACE >
MoFEMErrorCode	getInterface (IFACE *&iface) const
	Get interface reference to pointer of interface.
template<class IFACE >
MoFEMErrorCode	getInterface (IFACE **const iface) const
	Get interface pointer to pointer of interface.
template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get interface pointer to pointer of interface.
template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>
IFACE	getInterface () const
	Get reference to interface.
template<class IFACE >
IFACE *	getInterface () const
	Function returning pointer to interface.
virtual	~UnknownInterface ()=default

Public Attributes
const MoFEM::Interface &	cOre
bool	dEbug

Additional Inherited Members
Static Public Member Functions inherited from MoFEM::UnknownInterface
static MoFEMErrorCode	getLibVersion (Version &version)
	Get library version.
static MoFEMErrorCode	getFileVersion (moab::Interface &moab, Version &version)
	Get database major version.
static MoFEMErrorCode	setFileVersion (moab::Interface &moab, Version version=Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD))
	Get database major version.
static MoFEMErrorCode	getInterfaceVersion (Version &version)
	Get database major version.

Detailed Description

Vector manager is used to create vectors \mofem_vectors.

Managing Vectors, creation, scatter, etc.

Examples

mofem/atom_tests/prism_polynomial_approximation.cpp, mofem/atom_tests/quad_polynomial_approximation.cpp, mofem/atom_tests/remove_entities_from_problem_not_partitioned.cpp, mofem/tutorials/vec-7/adjoint.cpp, and mofem/users_modules/basic_finite_elements/nonlinear_elasticity/nonlinear_dynamics.cpp.

Definition at line 23 of file VecManager.hpp.

Constructor & Destructor Documentation

VecManager()

MoFEM::VecManager::VecManager

(

const MoFEM::Core &

core

)

Definition at line 14 of file VecManager.cpp.

    : cOre(const_cast<MoFEM::Core &>(core)), dEbug(false) {
  if (!LogManager::checkIfChannelExist("VECWORLD")) {
    auto core_log = logging::core::get();
 
    core_log->add_sink(
        LogManager::createSink(LogManager::getStrmWorld(), "VECWORLD"));
    core_log->add_sink(
        LogManager::createSink(LogManager::getStrmSync(), "VECSYNC"));
    core_log->add_sink(
        LogManager::createSink(LogManager::getStrmSelf(), "VECSELF"));
 
    LogManager::setLog("VECWORLD");
    LogManager::setLog("VECSYNC");
    LogManager::setLog("VECSELF");
 
    MOFEM_LOG_TAG("VECWORLD", "VecMng");
    MOFEM_LOG_TAG("VECSYNC", "VecMng");
    MOFEM_LOG_TAG("VECSELF", "VecMng");
  }
 
  MOFEM_LOG("VECWORLD", Sev::noisy) << "Vector manager created";
}

~VecManager()

MoFEM::VecManager::~VecManager ( )

default

Member Function Documentation

query_interface()

MoFEMErrorCode MoFEM::VecManager::query_interface ( boost::typeindex::type_index  type_index, UnknownInterface **  iface  ) const

virtual

Implements MoFEM::UnknownInterface.

Definition at line 8 of file VecManager.cpp.

                                                            {
  *iface = const_cast<VecManager *>(this);
  return 0;
}

setGlobalGhostVector() [1/2]

MoFEMErrorCode MoFEM::VecManager::setGlobalGhostVector	(	const Problem *	problem_ptr,
		RowColData	rc,
		Vec	V,
		InsertMode	mode,
		ScatterMode	scatter_mode
	)		const

\brief set values of vector from/to mesh database (collective)
\ingroup mofem_vectors

collective - need to be run on all processors in communicator

Parameters

pointer	to problem structure
RowColData	for row or column (ROW or COL)
V	vector
mode	see petsc manual for VecSetValue (ADD_VALUES or INSERT_VALUES)
scatter_mode	see petsc manual for ScatterMode (The available modes are: SCATTER_FORWARD or SCATTER_REVERSE)

SCATTER_REVERSE set data to field entities from V vector.

Definition at line 301 of file VecManager.cpp.

                                                                 {
  MoFEMFunctionBegin;
  typedef NumeredDofEntity_multiIndex::index<PetscGlobalIdx_mi_tag>::type
      DofsByGlobalIdx;
  DofsByGlobalIdx *dofs;
  DofIdx nb_dofs;
  switch (rc) {
  case ROW:
    nb_dofs = problem_ptr->getNbDofsRow();
    dofs = const_cast<DofsByGlobalIdx *>(
        &problem_ptr->numeredRowDofsPtr->get<PetscGlobalIdx_mi_tag>());
    break;
  case COL:
    nb_dofs = problem_ptr->getNbDofsCol();
    dofs = const_cast<DofsByGlobalIdx *>(
        &problem_ptr->numeredColDofsPtr->get<PetscGlobalIdx_mi_tag>());
    break;
  default:
    SETERRQ(PETSC_COMM_SELF, MOFEM_NOT_IMPLEMENTED,
            "Function works only for ROWs and COLs");
  }
  DofsByGlobalIdx::iterator miit = dofs->lower_bound(0);
  DofsByGlobalIdx::iterator hi_miit = dofs->upper_bound(nb_dofs);
  auto comm = PetscObjectComm((PetscObject)V);
  switch (scatter_mode) {
  case SCATTER_REVERSE: {
    VecScatter ctx;
    Vec V_glob;
    CHKERR VecScatterCreateToAll(V, &ctx, &V_glob);
    CHKERR VecScatterBegin(ctx, V, V_glob, INSERT_VALUES, SCATTER_FORWARD);
    CHKERR VecScatterEnd(ctx, V, V_glob, INSERT_VALUES, SCATTER_FORWARD);
    int size;
    CHKERR VecGetSize(V_glob, &size);
    if (size != nb_dofs) {
      SETERRQ(comm, MOFEM_DATA_INCONSISTENCY,
              "Size of vector is inconsistent with size of problem. You could "
              "use wrong vector with wrong problem, or you created vector "
              "before you remove DOFs from problem.");
    }
    PetscScalar *array;
    CHKERR VecGetArray(V_glob, &array);
    switch (mode) {
    case INSERT_VALUES:
      for (; miit != hi_miit; miit++)
        (*miit)->getFieldData() = array[(*miit)->getPetscGlobalDofIdx()];
      break;
    case ADD_VALUES:
      for (; miit != hi_miit; miit++)
        (*miit)->getFieldData() += array[(*miit)->getPetscGlobalDofIdx()];
      break;
    default:
      SETERRQ(comm, MOFEM_NOT_IMPLEMENTED, "not implemented");
    }
    CHKERR VecRestoreArray(V_glob, &array);
    CHKERR VecScatterDestroy(&ctx);
    CHKERR VecDestroy(&V_glob);
    break;
  }
  default:
    SETERRQ(comm, MOFEM_NOT_IMPLEMENTED, "not implemented");
  }
  MoFEMFunctionReturn(0);
}

setGlobalGhostVector() [2/2]

MoFEMErrorCode MoFEM::VecManager::setGlobalGhostVector	(	const std::string	name,
		RowColData	rc,
		Vec	V,
		InsertMode	mode,
		ScatterMode	scatter_mode
	)		const

\brief set values of vector from/to mesh database (collective)
\ingroup mofem_vectors

collective - need to be run on all processors in communicator

\param name of the problem

Parameters

RowColData	for row or column (ROW or COL)
V	vector
mode	see petsc manual for VecSetValue (ADD_VALUES or INSERT_VALUES)
scatter_mode	see petsc manual for ScatterMode (The available modes are: SCATTER_FORWARD or SCATTER_REVERSE)

SCATTER_REVERSE set data to field entities from V vector.

Definition at line 368 of file VecManager.cpp.

                                                                 {
  const MoFEM::Interface &m_field = cOre;
  const Problem *problem_ptr;
  MoFEMFunctionBegin;
  CHKERR m_field.get_problem(name, &problem_ptr);
  CHKERR setGlobalGhostVector(problem_ptr, rc, V, mode, scatter_mode);
  MoFEMFunctionReturn(0);
}

vecCreateGhost()

MoFEMErrorCode MoFEM::VecManager::vecCreateGhost	(	const std::string	name,
		RowColData	rc,
		SmartPetscObj< Vec > &	v_ptr
	)		const

create ghost vector for problem (collective)

collective - need to be run on all processors in communicator

Parameters

name	problem name
RowColData	specify what data is taken from Row, Col or Data
Vec	the vector where data is stored

Definition at line 122 of file VecManager.cpp.

                                                                           {
  MoFEMFunctionBegin;
  Vec vec;
  CHKERR vecCreateGhost(name, rc, &vec);
  v_ptr.reset(vec, false);
  MoFEMFunctionReturn(0);
}

vecScatterCreate() [1/2]

MoFEMErrorCode MoFEM::VecManager::vecScatterCreate	(	Vec	xin,
		const std::string	x_problem,
		const std::string	x_field_name,
		RowColData	x_rc,
		Vec	yin,
		const std::string	y_problem,
		const std::string	y_field_name,
		RowColData	y_rc,
		SmartPetscObj< VecScatter > &	smart_newctx
	)		const

create scatter for vectors from one to another problem (collective)

User specify what name of field on one problem is scattered to another.

Parameters

xin	vector
x_problem	problem name
x_field	name
yin	vector
y_problem	problem name
y_field_name

Return values

newctx

scatter

Definition at line 177 of file VecManager.cpp.

                                                                            {
  MoFEMFunctionBegin;
  VecScatter newctx;
  CHKERR vecScatterCreate(xin, x_problem, x_field_name, x_rc, yin, y_problem,
                          y_field_name, y_rc, &newctx);
  smart_newctx = SmartPetscObj<VecScatter>(newctx);
  MoFEMFunctionReturn(0);
}

vecScatterCreate() [2/2]

MoFEMErrorCode MoFEM::VecManager::vecScatterCreate	(	Vec	xin,
		const std::string	x_problem,
		RowColData	x_rc,
		Vec	yin,
		const std::string	y_problem,
		RowColData	y_rc,
		SmartPetscObj< VecScatter > &	smart_newctx
	)		const

create scatter for vectors from one to another problem (collective)

User specify what name of field on one problem is scattered to another.

Parameters

xin	vector
x_problem	problem name
x_field	name
yin	vector
y_problem	problem name
y_field_name

Return values

newctx

scatter

Definition at line 191 of file VecManager.cpp.

                                                                            {
  MoFEMFunctionBegin;
  VecScatter newctx;
  CHKERR vecScatterCreate(xin, x_problem, x_rc, yin, y_problem, y_rc, &newctx);
  smart_newctx = SmartPetscObj<VecScatter>(newctx);
  MoFEMFunctionReturn(0);
}

Member Data Documentation

cOre

const MoFEM::Interface& MoFEM::VecManager::cOre

Definition at line 28 of file VecManager.hpp.

dEbug

bool MoFEM::VecManager::dEbug

Definition at line 29 of file VecManager.hpp.

---

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

• src/interfaces/VecManager.hpp
• src/interfaces/impl/VecManager.cpp