Fix dofs on entities. More...

#include "users_modules/basic_finite_elements/src/DirichletBC.hpp"

Inheritance diagram for DirichletFixFieldAtEntitiesBc:

Collaboration diagram for DirichletFixFieldAtEntitiesBc:

Public Member Functions
	DirichletFixFieldAtEntitiesBc (MoFEM::Interface &m_field, const std::string field_name, Mat aij, Vec x, Vec f, Range &ents)

	DirichletFixFieldAtEntitiesBc (MoFEM::Interface &m_field, const std::string field_name, Range &ents)

MoFEMErrorCode	iNitialize ()

MoFEMErrorCode	preProcess ()
	function is run at the beginning of loop

MoFEMErrorCode	postProcess ()
	function is run at the end of loop

Public Member Functions inherited from DirichletDisplacementBc
	DirichletDisplacementBc (MoFEM::Interface &m_field, const std::string &field_name, Mat Aij, Vec X, Vec F, string blockset_name="DISPLACEMENT")

	DirichletDisplacementBc (MoFEM::Interface &m_field, const std::string &field_name, string blockset_name="DISPLACEMENT")

MoFEMErrorCode	operator() ()
	function is run for every finite element

MoFEMErrorCode	getBcDataFromSetsAndBlocks (std::vector< DataFromBc > &bc_data)
	Get the Bc Data From Sets And Blocks object Use DISPLACEMENT blockset name (default) with 6 atributes: 1,2,3 are values of displacements x,y,z 4,5,6 are flags for x,y,z (0 or 1)

MoFEMErrorCode	getRotationBcFromBlock (std::vector< DataFromBc > &bc_data)
	Get the Rotation Bc From Block object Use ROTATION blockset name with 7 atributes: 1,2,3 are x,y,z coords of the center of rotation 4,5,6 are are angular velocities in x,y,z.

MoFEMErrorCode	calculateRotationForDof (VectorDouble3 &coords, DataFromBc &bc_data)
	Calculate displacements from rotation for particular dof.

MoFEMErrorCode	calculateRotationForDof (EntityHandle ent, DataFromBc &bc_data)

MoFEMErrorCode	applyScaleBcData (DataFromBc &bc_data)

Public Member Functions inherited from MoFEM::FEMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	FEMethod ()=default

auto	getFEName () const
	get finite element name

auto	getDataDofsPtr () const

auto	getDataVectorDofsPtr () const

const FieldEntity_vector_view &	getDataFieldEnts () const

boost::shared_ptr< FieldEntity_vector_view > &	getDataFieldEntsPtr () const

auto &	getRowFieldEnts () const

auto &	getRowFieldEntsPtr () const

auto &	getColFieldEnts () const

auto &	getColFieldEntsPtr () const

auto	getRowDofsPtr () const

auto	getColDofsPtr () const

auto	getNumberOfNodes () const

EntityHandle	getFEEntityHandle () const

MoFEMErrorCode	getNodeData (const std::string field_name, VectorDouble &data, const bool reset_dofs=true)

Public Member Functions inherited from MoFEM::BasicMethod
	BasicMethod ()

virtual	~BasicMethod ()=default

int	getNinTheLoop () const
	get number of evaluated element in the loop

int	getLoopSize () const
	get loop size

auto	getLoHiFERank () const
	Get lo and hi processor rank of iterated entities.

auto	getLoFERank () const
	Get upper rank in loop for iterating elements.

auto	getHiFERank () const
	Get upper rank in loop for iterating elements.

unsigned int	getFieldBitNumber (std::string field_name) const

MoFEMErrorCode	copyBasicMethod (const BasicMethod &basic)
	Copy data from other base method to this base method.

boost::weak_ptr< CacheTuple >	getCacheWeakPtr () const
	Get the cache weak ptr object.

Public Member Functions inherited from MoFEM::KspMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	KspMethod ()

virtual	~KspMethod ()=default

MoFEMErrorCode	copyKsp (const KspMethod &ksp)
	copy data form another method

Public Member Functions inherited from MoFEM::PetscData
	PetscData ()

virtual	~PetscData ()=default

MoFEMErrorCode	copyPetscData (const PetscData &petsc_data)

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 Member Functions inherited from MoFEM::SnesMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	SnesMethod ()

virtual	~SnesMethod ()=default

MoFEMErrorCode	copySnes (const SnesMethod &snes)
	Copy snes data.

Public Member Functions inherited from MoFEM::TSMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	TSMethod ()

virtual	~TSMethod ()=default

MoFEMErrorCode	copyTs (const TSMethod &ts)
	Copy TS solver data.

Public Member Functions inherited from MoFEM::TaoMethod
MoFEMErrorCode	query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const

	TaoMethod ()

virtual	~TaoMethod ()=default

MoFEMErrorCode	copyTao (const TaoMethod &tao)
	Copy TAO data.

Public Attributes
Range	eNts

std::vector< std::string >	fieldNames

Public Attributes inherited from DirichletDisplacementBc
MoFEM::Interface &	mField

const std::string	fieldName
	field name to set Dirichlet BC

double	dIag
	diagonal value set on zeroed column and rows

std::map< DofIdx, FieldData >	mapZeroRows

std::vector< int >	dofsIndices

std::vector< double >	dofsValues

std::vector< double >	dofsXValues

const std::string	blocksetName

boost::ptr_vector< MethodForForceScaling >	methodsOp

Public Attributes inherited from MoFEM::FEMethod
std::string	feName
	Name of finite element.

boost::shared_ptr< const NumeredEntFiniteElement >	numeredEntFiniteElementPtr

boost::function< bool(FEMethod *fe_method_ptr)>	exeTestHook
	Tet if element to skip element.

Public Attributes inherited from MoFEM::BasicMethod
int	nInTheLoop
	number currently of processed method

int	loopSize
	local number oe methods to process

std::pair< int, int >	loHiFERank
	Llo and hi processor rank of iterated entities.

int	rAnk
	processor rank

int	sIze
	number of processors in communicator

const RefEntity_multiIndex *	refinedEntitiesPtr
	container of mofem dof entities

const RefElement_multiIndex *	refinedFiniteElementsPtr
	container of mofem finite element entities

const Problem *	problemPtr
	raw pointer to problem

const Field_multiIndex *	fieldsPtr
	raw pointer to fields container

const FieldEntity_multiIndex *	entitiesPtr
	raw pointer to container of field entities

const DofEntity_multiIndex *	dofsPtr
	raw pointer container of dofs

const FiniteElement_multiIndex *	finiteElementsPtr
	raw pointer to container finite elements

const EntFiniteElement_multiIndex *	finiteElementsEntitiesPtr

const FieldEntityEntFiniteElementAdjacencyMap_multiIndex *	adjacenciesPtr

boost::function< MoFEMErrorCode()>	preProcessHook
	Hook function for pre-processing.

boost::function< MoFEMErrorCode()>	postProcessHook
	Hook function for post-processing.

boost::function< MoFEMErrorCode()>	operatorHook
	Hook function for operator.

boost::movelib::unique_ptr< bool >	vecAssembleSwitch

boost::movelib::unique_ptr< bool >	matAssembleSwitch

boost::weak_ptr< CacheTuple >	cacheWeakPtr

Public Attributes inherited from MoFEM::KspMethod
KSPContext	ksp_ctx
	Context.

KSP	ksp
	KSP solver.

Vec &	ksp_f

Mat &	ksp_A

Mat &	ksp_B

Public Attributes inherited from MoFEM::PetscData
Switches	data_ctx

Vec	f

Mat	A

Mat	B

Vec	x

Vec	dx

Vec	x_t

Vec	x_tt

Public Attributes inherited from MoFEM::SnesMethod
SNESContext	snes_ctx

SNES	snes
	snes solver

Vec &	snes_x
	state vector

Vec &	snes_dx
	solution update

Vec &	snes_f
	residual

Mat &	snes_A
	jacobian matrix

Mat &	snes_B
	preconditioner of jacobian matrix

Public Attributes inherited from MoFEM::TSMethod
TS	ts
	time solver

TSContext	ts_ctx

PetscInt	ts_step
	time step number

PetscReal	ts_a
	shift for U_t (see PETSc Time Solver)

PetscReal	ts_aa
	shift for U_tt shift for U_tt

PetscReal	ts_t
	time

PetscReal	ts_dt
	time step size

Vec &	ts_u
	state vector

Vec &	ts_u_t
	time derivative of state vector

Vec &	ts_u_tt
	second time derivative of state vector

Vec &	ts_F
	residual vector

Mat &	ts_A

Mat &	ts_B
	Preconditioner for ts_A.

Public Attributes inherited from MoFEM::TaoMethod
TAOContext	tao_ctx

Tao	tao
	tao solver

Vec &	tao_x

Vec &	tao_f
	state vector

Mat &	tao_A
	gradient vector

Mat &	tao_B
	hessian matrix

Additional Inherited Members
Public Types inherited from MoFEM::KspMethod
enum	KSPContext { CTX_SETFUNCTION , CTX_OPERATORS , CTX_KSPNONE }
	pass information about context of KSP/DM for with finite element is computed More...

Public Types inherited from MoFEM::PetscData
enum	DataContext { CTX_SET_NONE = 0 , CTX_SET_F = 1 << 0 , CTX_SET_A = 1 << 1 , CTX_SET_B = 1 << 2 , CTX_SET_X = 1 << 3 , CTX_SET_DX = 1 << 4 , CTX_SET_X_T = 1 << 5 , CTX_SET_X_TT = 1 << 6 , CTX_SET_TIME = 1 << 7 }

using	Switches = std::bitset<8>

Public Types inherited from MoFEM::SnesMethod
enum	SNESContext { CTX_SNESSETFUNCTION , CTX_SNESSETJACOBIAN , CTX_SNESNONE }

Public Types inherited from MoFEM::TSMethod
enum	TSContext { CTX_TSSETRHSFUNCTION , CTX_TSSETRHSJACOBIAN , CTX_TSSETIFUNCTION , CTX_TSSETIJACOBIAN , CTX_TSTSMONITORSET , CTX_TSNONE }

Public Types inherited from MoFEM::TaoMethod
enum	TAOContext { CTX_TAO_OBJECTIVE , CTX_TAO_GRADIENT , CTX_TAO_HESSIAN , CTX_TAO_NONE }

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.

Static Public Attributes inherited from MoFEM::PetscData
static constexpr Switches	CtxSetNone = PetscData::Switches(CTX_SET_NONE)

static constexpr Switches	CtxSetF = PetscData::Switches(CTX_SET_F)

static constexpr Switches	CtxSetA = PetscData::Switches(CTX_SET_A)

static constexpr Switches	CtxSetB = PetscData::Switches(CTX_SET_B)

static constexpr Switches	CtxSetX = PetscData::Switches(CTX_SET_X)

static constexpr Switches	CtxSetDX = PetscData::Switches(CTX_SET_DX)

static constexpr Switches	CtxSetX_T = PetscData::Switches(CTX_SET_X_T)

static constexpr Switches	CtxSetX_TT = PetscData::Switches(CTX_SET_X_TT)

static constexpr Switches	CtxSetTime = PetscData::Switches(CTX_SET_TIME)

Detailed Description

Fix dofs on entities.

Examples: mesh_smoothing.cpp, and minimal_surface_area.cpp.

Definition at line 258 of file DirichletBC.hpp.

Constructor & Destructor Documentation

◆ DirichletFixFieldAtEntitiesBc() [1/2]

DirichletFixFieldAtEntitiesBc::DirichletFixFieldAtEntitiesBc	(	MoFEM::Interface &	m_field,
		const std::string	field_name,
		Mat	aij,
		Vec	x,
		Vec	f,
		Range &	ents )

inline

Definition at line 262 of file DirichletBC.hpp.

      : DirichletDisplacementBc(m_field, field_name, aij, x, f), eNts(ents) {
    fieldNames.push_back(fieldName);
  }

◆ DirichletFixFieldAtEntitiesBc() [2/2]

DirichletFixFieldAtEntitiesBc::DirichletFixFieldAtEntitiesBc	(	MoFEM::Interface &	m_field,
		const std::string	field_name,
		Range &	ents )

inline

Definition at line 269 of file DirichletBC.hpp.

      : DirichletDisplacementBc(m_field, field_name), eNts(ents) {
    fieldNames.push_back(fieldName);
  }

Member Function Documentation

◆ iNitialize()

MoFEMErrorCode DirichletFixFieldAtEntitiesBc::iNitialize ( )

virtual

Reimplemented from DirichletDisplacementBc.

Definition at line 558 of file DirichletBC.cpp.

                                                         {
  MoFEMFunctionBegin;
  if (mapZeroRows.empty()) {
 
    for (const auto &field_name : fieldNames) {
 
      auto for_each_dof = [&](auto &dof) {
        MoFEMFunctionBeginHot;
        mapZeroRows[dof->getPetscGlobalDofIdx()] = 0;
        MoFEMFunctionReturnHot(0);
      };
 
      CHKERR set_numered_dofs_on_ents(problemPtr,
                                      mField.get_field_bit_number(field_name),
                                      eNts, for_each_dof);
    }
 
    dofsIndices.resize(mapZeroRows.size());
    dofsValues.resize(mapZeroRows.size());
    int ii = 0;
    for (auto mit = mapZeroRows.begin(); mit != mapZeroRows.end();
         ++mit, ++ii) {
      dofsIndices[ii] = mit->first;
      dofsValues[ii] = mit->second;
    }
  }
  MoFEMFunctionReturn(0);
}

◆ postProcess()

MoFEMErrorCode DirichletFixFieldAtEntitiesBc::postProcess ( )

virtual

function is run at the end of loop

It is used to assembly matrices and vectors, calculating global variables, f.e. total internal energy, ect.

Iterating over dofs: Example1 iterating over dofs in row by name of the field for(IT_GET_FEROW_BY_NAME_DOFS_FOR_LOOP(this,"DISPLACEMENT",it)) { ... }

Reimplemented from DirichletDisplacementBc.

Definition at line 594 of file DirichletBC.cpp.

                                                          {
  MoFEMFunctionBegin;
  if (snes_ctx == CTX_SNESNONE) {
    if (snes_B) {
      CHKERR MatAssemblyBegin(snes_B, MAT_FINAL_ASSEMBLY);
      CHKERR MatAssemblyEnd(snes_B, MAT_FINAL_ASSEMBLY);
      CHKERR MatZeroRowsColumns(snes_B, dofsIndices.size(),
                                dofsIndices.empty() ? PETSC_NULLPTR
                                                    : &*dofsIndices.begin(),
                                dIag, PETSC_NULLPTR, PETSC_NULLPTR);
    }
    if (snes_f) {
      CHKERR VecAssemblyBegin(snes_f);
      CHKERR VecAssemblyEnd(snes_f);
      int ii = 0;
      for (std::vector<int>::iterator vit = dofsIndices.begin();
           vit != dofsIndices.end(); vit++, ii++) {
        CHKERR VecSetValue(snes_f, *vit, dofsValues[ii], INSERT_VALUES);
      }
      CHKERR VecAssemblyBegin(snes_f);
      CHKERR VecAssemblyEnd(snes_f);
    }
  }
 
  switch (snes_ctx) {
  case CTX_SNESNONE: {
  } break;
  case CTX_SNESSETFUNCTION: {
    CHKERR VecAssemblyBegin(snes_f);
    CHKERR VecAssemblyEnd(snes_f);
    int ii = 0;
    for (std::vector<int>::iterator vit = dofsIndices.begin();
         vit != dofsIndices.end(); vit++, ii++) {
      CHKERR VecSetValue(snes_f, *vit, dofsValues[ii], INSERT_VALUES);
    }
    CHKERR VecAssemblyBegin(snes_f);
    CHKERR VecAssemblyEnd(snes_f);
  } break;
  case CTX_SNESSETJACOBIAN: {
    CHKERR MatAssemblyBegin(snes_B, MAT_FINAL_ASSEMBLY);
    CHKERR MatAssemblyEnd(snes_B, MAT_FINAL_ASSEMBLY);
    CHKERR MatZeroRowsColumns(snes_B, dofsIndices.size(),
                              dofsIndices.empty() ? PETSC_NULLPTR
                                                  : &*dofsIndices.begin(),
                              dIag, PETSC_NULLPTR, PETSC_NULLPTR);
  } break;
  default:
    SETERRQ(PETSC_COMM_SELF, MOFEM_DATA_INCONSISTENCY, "unknown snes stage");
  }
 
  MoFEMFunctionReturn(0);
}

◆ preProcess()

MoFEMErrorCode DirichletFixFieldAtEntitiesBc::preProcess ( )

virtual

function is run at the beginning of loop

It is used to zeroing matrices and vectors, calculation of shape functions on reference element, preprocessing boundary conditions, etc.

Reimplemented from DirichletDisplacementBc.

Definition at line 587 of file DirichletBC.cpp.

                                                         {
  MoFEMFunctionBegin;
 
  CHKERR iNitialize();
  MoFEMFunctionReturn(0);
}

Member Data Documentation

◆ eNts

Range DirichletFixFieldAtEntitiesBc::eNts

Definition at line 260 of file DirichletBC.hpp.

◆ fieldNames

std::vector<std::string> DirichletFixFieldAtEntitiesBc::fieldNames

Definition at line 261 of file DirichletBC.hpp.

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

users_modules/basic_finite_elements/src/DirichletBC.hpp
users_modules/basic_finite_elements/src/impl/DirichletBC.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DirichletFixFieldAtEntitiesBc() [1/2]

◆ DirichletFixFieldAtEntitiesBc() [2/2]

Member Function Documentation

◆ iNitialize()

◆ postProcess()

◆ preProcess()

Member Data Documentation

◆ eNts

◆ fieldNames