libMesh::FEType Class Reference

class FEType hides (possibly multiple) FEFamily and approximation orders, thereby enabling specialized finite element families. More...

#include <fe_type.h>

Public Member Functions
	FEType (const int o=1, const FEFamily f=LAGRANGE)
	Constructor.
	FEType (const int o=1, const FEFamily f=LAGRANGE, const int ro=THIRD, const FEFamily rf=JACOBI_20_00, const InfMapType im=CARTESIAN)
	Constructor.
FEType	set_p_refinement (bool p) &
	"Fluent API" for constructing a non-default p_refinement, for easier compatibility between non-InfFE and InfFE code
FEType	set_p_refinement (bool p) &&
	Specialization for rvalues so we don't return a dangling reference to a temporary.
bool	operator== (const FEType &f2) const
	Tests equality.
bool	operator!= (const FEType &f2) const
	Tests inequality.
bool	operator< (const FEType &f2) const
	An ordering to make FEType useful as a std::map key.
Order	default_quadrature_order () const
std::unique_ptr< QBase >	default_quadrature_rule (const unsigned int dim, const int extraorder=0) const
Order	unweighted_quadrature_order () const
std::unique_ptr< QBase >	unweighted_quadrature_rule (const unsigned int dim, const int extraorder=0) const

Public Attributes
OrderWrapper	order
	The approximation order of the element (at 0 p-refinement level).
FEFamily	family
	The type of finite element.
OrderWrapper	radial_order
	The approximation order in radial direction of the infinite element.
FEFamily	radial_family
	The type of approximation in radial direction.
InfMapType	inf_map
	The coordinate mapping type of the infinite element.
bool	p_refinement
	Whether or not the finite elements for this type increase their p refinement level on geometric elements of increased p level.

Detailed Description

class FEType hides (possibly multiple) FEFamily and approximation orders, thereby enabling specialized finite element families.

Author

Benjamin S. Kirk

Date

2002

Manages the family, order, etc. parameters for a given FE.

Definition at line 196 of file fe_type.h.

Constructor & Destructor Documentation

FEType() [1/2]

libMesh::FEType::FEType ( const int  o = 1, const FEFamily  f = LAGRANGE  )

inline

Constructor.

Optionally takes the approximation Order, the finite element family FEFamily.

We can't set p_refinement in this argument list without conflicting with the ro parameter in the InfFE-compatible constructor version below, so we use the set_p_refinement API below to potentially convert an FEType with p-refinement (the default) to one without.

Definition at line 217 of file fe_type.h.

                                      :
    order(o),
    family(f),
    p_refinement(true)
  {}

FEType() [2/2]

libMesh::FEType::FEType ( const int  o = 1, const FEFamily  f = LAGRANGE, const int  ro = THIRD, const FEFamily  rf = JACOBI_20_00, const InfMapType  im = CARTESIAN  )

inline

Constructor.

Optionally takes the approximation Order and the finite element family FEFamily.

Note

For non-infinite elements, the order and base order are the same, as with the family and base_family. It must be so, otherwise what we switch on would change when infinite elements are not compiled in.

We can't set p_refinement in this argument list in a way that matches the non-InfFE-enabled constructor version above, so we use the set_p_refinement API below to potentially convert an FEType with p-refinement (the default) to one without.

Definition at line 246 of file fe_type.h.

           :
    order(o),
    radial_order(ro),
    family(f),
    radial_family(rf),
    inf_map(im),
    p_refinement(true)
  {}

Member Function Documentation

default_quadrature_order()

Order libMesh::FEType::default_quadrature_order ( ) const

inline

Returns

The default quadrature order for this FEType, on an element without p refinement. The default quadrature order is calculated assuming a polynomial of degree order and is based on integrating the mass matrix for such an element exactly on affine elements.

Definition at line 415 of file fe_type.h.

{
  return static_cast<Order>(2*static_cast<unsigned int>(order.get_order()) + 1);
}

References libMesh::OrderWrapper::get_order(), and order.

Referenced by alternative_fe_assembly(), LinearElasticity::assemble(), AssembleOptimization::assemble_A_and_F(), libMesh::ClawSystem::assemble_advection_matrices(), libMesh::ClawSystem::assemble_avg_coupling_matrices(), libMesh::ClawSystem::assemble_boundary_condition_matrices(), assemble_cd(), assemble_divgrad(), assemble_elasticity(), assemble_ellipticdg(), assemble_graddiv(), libMesh::ClawSystem::assemble_jump_coupling_matrix(), libMesh::ClawSystem::assemble_mass_matrix(), assemble_poisson(), assemble_poisson(), assemble_shell(), assemble_stokes(), assemble_temperature_jump(), compute_jacobian(), libMesh::FEGenericBase< OutputType >::compute_periodic_constraints(), libMesh::FEGenericBase< OutputType >::compute_proj_constraints(), compute_residual(), LinearElasticity::compute_stresses(), LargeDeformationElasticity::compute_stresses(), LinearElasticityWithContact::compute_stresses(), compute_stresses(), default_quadrature_rule(), fe_assembly(), form_functionA(), form_functionB(), form_matrixA(), LargeDeformationElasticity::jacobian(), OverlappingCouplingFunctor::operator()(), periodic_bc_test_poisson(), libMesh::FE< Dim, T >::reinit_default_dual_shape_coeffs(), LargeDeformationElasticity::residual(), LinearElasticityWithContact::residual_and_jacobian(), DualShapeTest::setUp(), FETestBase< order, family, elem_type, build_nx, CaseName >::setUp(), InfFERadialTest::testInfQuants(), InfFERadialTest::testSides(), InfFERadialTest::testSingleOrder(), libMesh::Elem::true_centroid(), and libMesh::Elem::volume().

default_quadrature_rule()

std::unique_ptr< QBase > libMesh::FEType::default_quadrature_rule	(	const unsigned int	dim,
		const int	extraorder = 0
	)		const

Returns

A quadrature rule of appropriate type and order for this FEType, on an element without p refinement.

The default quadrature rule is based on integrating the mass matrix for such an element exactly, with an additional power on the basis order to help account for nonlinearities and/or nonuniform coefficients. Higher or lower degree rules can be chosen by changing the extraorder parameter.

Definition at line 34 of file fe_type.C.

{
  // Clough elements have at least piecewise cubic functions
  if (family == CLOUGH)
    {
      Order o = static_cast<Order>(std::max(static_cast<unsigned int>(this->default_quadrature_order()),
                                            static_cast<unsigned int>(7 + extraorder)));
      return std::make_unique<QClough>(dim, o);
    }
 
  if (family == SUBDIVISION)
    return std::make_unique<QGauss>(dim, static_cast<Order>(1 + extraorder));
 
  return std::make_unique<QGauss>(dim, static_cast<Order>(this->default_quadrature_order() + extraorder));
}

References libMesh::CLOUGH, default_quadrature_order(), dim, family, and libMesh::SUBDIVISION.

Referenced by libMesh::ExactSolution::_compute_error(), libMesh::UniformRefinementEstimator::_estimate_error(), libMesh::RBConstruction::add_scaled_matrix_and_vector(), assemble_biharmonic(), assemble_func(), assemble_laplace(), assemble_shell(), libMesh::System::calculate_norm(), libMesh::FEGenericBase< OutputType >::coarsened_dof_values(), libMesh::ExactErrorEstimator::estimate_error(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::SmoothnessEstimator::EstimateSmoothness::operator()(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::BoundaryProjectSolution::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), Biharmonic::JR::residual_and_jacobian(), libMesh::HPCoarsenTest::select_refinement(), FETest< order, family, elem_type, CaseName >::testCustomReinit(), and libMesh::FEMContext::use_default_quadrature_rules().

operator!=()

bool libMesh::FEType::operator!= ( const FEType &  f2 ) const

inline

Tests inequality.

Definition at line 333 of file fe_type.h.

  {
    return !(*this == f2);
  }

operator<()

bool libMesh::FEType::operator< ( const FEType &  f2 ) const

inline

An ordering to make FEType useful as a std::map key.

Definition at line 341 of file fe_type.h.

  {
    if (order != f2.order)
      return (order < f2.order);
    if (family != f2.family)
      return (family < f2.family);
    if (p_refinement != f2.p_refinement)
      return (p_refinement < f2.p_refinement);
#ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
    if (radial_order != f2.radial_order)
      return (radial_order < f2.radial_order);
    if (radial_family != f2.radial_family)
      return (radial_family < f2.radial_family);
    if (inf_map != f2.inf_map)
      return (inf_map < f2.inf_map);
#endif // ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
    return false;
  }

References family, inf_map, order, p_refinement, radial_family, and radial_order.

operator==()

bool libMesh::FEType::operator== ( const FEType &  f2 ) const

inline

Tests equality.

Definition at line 317 of file fe_type.h.

  {
    return (order == f2.order
            && family == f2.family
            && p_refinement == f2.p_refinement
#ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
            && radial_order == f2.radial_order
            && radial_family == f2.radial_family
            && inf_map == f2.inf_map
#endif // ifdef LIBMESH_ENABLE_INFINITE_ELEMENTS
            );
  }

References family, inf_map, order, p_refinement, radial_family, and radial_order.

set_p_refinement() [1/2]

FEType libMesh::FEType::set_p_refinement ( bool  p ) &

inline

"Fluent API" for constructing a non-default p_refinement, for easier compatibility between non-InfFE and InfFE code

Definition at line 298 of file fe_type.h.

  {
    this->p_refinement = p;
    return *this;
  }

Referenced by MeshInputTest::testCopyElementSolutionImpl(), MeshInputTest::testCopyElementVectorImpl(), and MeshInputTest::testExodusWriteElementDataFromDiscontinuousNodalData().

set_p_refinement() [2/2]

FEType libMesh::FEType::set_p_refinement ( bool  p ) &&

inline

Specialization for rvalues so we don't return a dangling reference to a temporary.

Definition at line 308 of file fe_type.h.

  {
    this->p_refinement = p;
    return std::move(*this);
  }

unweighted_quadrature_order()

Order libMesh::FEType::unweighted_quadrature_order ( ) const

inline

Returns

The default quadrature order for integrating unweighted basis functions of this FEType, on an element without p refinement.

The unweighted quadrature order is calculated assuming a polynomial of degree order and is based on integrating the shape functions for such an element exactly on affine elements.

Definition at line 421 of file fe_type.h.

{
  return order;
}

References order.

Referenced by unweighted_quadrature_rule().

unweighted_quadrature_rule()

std::unique_ptr< QBase > libMesh::FEType::unweighted_quadrature_rule	(	const unsigned int	dim,
		const int	extraorder = 0
	)		const

Returns

A quadrature rule of appropriate type and order for unweighted integration of this FEType, on an element without p refinement

The default quadrature rule is based on integrating the shape functions on an affine element exactly. Higher or lower degree rules can be chosen by changing the extraorder parameter.

Definition at line 53 of file fe_type.C.

{
  // Clough elements have at least piecewise cubic functions
  if (family == CLOUGH)
    {
      Order o = static_cast<Order>(std::max(static_cast<unsigned int>(this->unweighted_quadrature_order()),
                                            static_cast<unsigned int>(3 + extraorder)));
      return std::make_unique<QClough>(dim, o);
    }
 
  if (family == SUBDIVISION)
    return std::make_unique<QGauss>(dim, static_cast<Order>(1 + extraorder));
 
  return std::make_unique<QGauss>(dim, static_cast<Order>(this->unweighted_quadrature_order() + extraorder));
}

References libMesh::CLOUGH, dim, family, libMesh::SUBDIVISION, and unweighted_quadrature_order().

Referenced by libMesh::JumpErrorEstimator::estimate_error(), and libMesh::FEMContext::use_unweighted_quadrature_rules().

Member Data Documentation

family

FEFamily libMesh::FEType::family

The type of finite element.

For InfFE, family contains the radial shape family, while base_family contains the approximation type in circumferential direction.

Valid types are LAGRANGE, HIERARCHIC, etc...

Definition at line 228 of file fe_type.h.

Referenced by libMesh::DofMap::_dof_indices(), libMesh::FEMSystem::assembly(), libMesh::FETransformationBase< OutputShape >::build(), libMesh::FEGenericBase< OutputType >::build(), libMesh::FEAbstract::build(), libMesh::FEMap::build(), libMesh::FEMContext::build_new_fe(), libMesh::FEInterface::compute_constraints(), libMesh::FEGenericBase< FEOutputType< T >::type >::compute_periodic_constraints(), libMesh::GMVIO::copy_nodal_solution(), default_quadrature_rule(), libMesh::DofMap::distribute_local_dofs_node_major(), libMesh::DofMap::distribute_local_dofs_var_major(), libMesh::DofMap::distribute_scalar_dofs(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::JumpErrorEstimator::estimate_error(), libMesh::FEInterface::extra_hanging_dofs(), TIMPI::OpFunction< libMesh::FEType >::fetype_max(), TIMPI::OpFunction< libMesh::FEType >::fetype_min(), libMesh::FEInterface::field_type(), libMesh::FEMContext::find_hardest_fe_type(), libMesh::FEInterface::get_continuity(), libMesh::FEAbstract::get_family(), libMesh::DifferentiableSystem::have_first_order_scalar_vars(), libMesh::DifferentiableSystem::have_second_order_scalar_vars(), libMesh::InfFE< Dim, T_radial, T_map >::inf_compute_constraints(), libMesh::FEMContext::init_internal_data(), libMesh::EquationSystems::is_elemental_data_fe_type(), libMesh::FEInterface::is_hierarchic(), main(), libMesh::FEInterface::max_order(), libMesh::Variable::n_components(), libMesh::Variable::n_components(), libMesh::FEInterface::n_vec_dim(), libMesh::DifferentiablePhysics::nonlocal_mass_residual(), libMesh::DofMap::old_dof_indices(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::BoundaryProjectSolution::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), std::hash< libMesh::FEType >::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), libMesh::MeshFunction::operator()(), operator<(), operator==(), libMesh::DofMap::process_mesh_constraint_rows(), libMesh::System::project_vector(), libMesh::System::read_header(), libMesh::System::read_serialized_vectors(), libMesh::StaticCondensationDofMap::reinit(), TIMPI::Attributes< libMesh::FEType >::set_highest(), TIMPI::Attributes< libMesh::FEType >::set_lowest(), libMesh::PetscPreconditioner< T >::set_petsc_aux_data(), libMesh::PetscDMWrapper::set_point_range_in_section(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SubFunctor::SubFunctor(), libMesh::MeshFunctionSolutionTransfer::transfer(), unweighted_quadrature_rule(), libMesh::System::write_header(), libMesh::Nemesis_IO_Helper::write_nodal_solution(), libMesh::System::write_parallel_data(), libMesh::System::write_serialized_vector(), and libMesh::System::write_serialized_vectors().

inf_map

InfMapType libMesh::FEType::inf_map

The coordinate mapping type of the infinite element.

When the infinite elements are defined over a surface with a separable coordinate system (sphere, spheroid, ellipsoid), the infinite elements may take advantage of this fact.

Definition at line 284 of file fe_type.h.

Referenced by libMesh::FEGenericBase< FEOutputType< T >::type >::determine_calculations(), libMesh::FEInterface::ifem_inverse_map(), libMesh::FEInterface::ifem_inverse_map(), libMesh::FEInterface::ifem_map(), libMesh::FEInterface::ifem_nodal_soln(), libMesh::InfFE< Dim, T_radial, T_map >::InfFE(), std::hash< libMesh::FEType >::operator()(), operator<(), operator==(), libMesh::System::read_header(), and libMesh::System::write_header().

order

OrderWrapper libMesh::FEType::order

The approximation order of the element (at 0 p-refinement level).

Definition at line 203 of file fe_type.h.

Referenced by libMesh::DofMap::_dof_indices(), libMesh::PetscDMWrapper::add_dofs_to_section(), libMesh::FEInterface::all_shape_derivs(), libMesh::FEInterface::all_shapes(), libMesh::FEInterface::all_shapes(), libMesh::FEMContext::build_new_fe(), libMesh::FEGenericBase< OutputType >::coarsened_dof_values(), libMesh::FEAbstract::compute_node_constraints(), libMesh::FEGenericBase< OutputType >::compute_proj_constraints(), libMesh::GMVIO::copy_nodal_solution(), default_quadrature_order(), libMesh::DofMap::distribute_scalar_dofs(), libMesh::DofMap::dof_indices(), libMesh::DofMap::dof_indices(), libMesh::FEInterface::dofs_on_edge(), libMesh::FEInterface::dofs_on_side(), TIMPI::OpFunction< libMesh::FEType >::fetype_max(), TIMPI::OpFunction< libMesh::FEType >::fetype_min(), libMesh::FEMContext::find_hardest_fe_type(), libMesh::FEAbstract::get_order(), libMesh::EquationSystems::is_elemental_data_fe_type(), main(), libMesh::Variable::n_components(), libMesh::Variable::n_components(), libMesh::FEInterface::n_dofs(), libMesh::FEInterface::n_dofs(), libMesh::FEInterface::n_dofs(), libMesh::FEInterface::n_dofs(), libMesh::FEInterface::n_dofs_at_node(), libMesh::FEInterface::n_dofs_at_node(), libMesh::FEInterface::n_dofs_at_node(), libMesh::FEInterface::n_dofs_per_elem(), libMesh::FEInterface::n_dofs_per_elem(), libMesh::FEInterface::n_dofs_per_elem(), libMesh::FEInterface::n_shape_functions(), libMesh::FEInterface::n_shape_functions(), libMesh::FEInterface::n_shape_functions(), libMesh::FEInterface::nodal_soln(), libMesh::DofMap::old_dof_indices(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::PatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::SmoothnessEstimator::EstimateSmoothness::operator()(), libMesh::WeightedPatchRecoveryErrorEstimator::EstimateError::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), std::hash< libMesh::FEType >::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectEdges::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), operator<(), operator==(), libMesh::System::read_header(), libMesh::System::read_SCALAR_dofs(), libMesh::FEAbstract::set_fe_order(), TIMPI::Attributes< libMesh::FEType >::set_highest(), TIMPI::Attributes< libMesh::FEType >::set_lowest(), libMesh::PetscPreconditioner< T >::set_petsc_aux_data(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::InfFE< Dim, T_radial, T_map >::shape(), libMesh::FE< Dim, T >::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape(), libMesh::FEInterface::shape_deriv(), libMesh::FEInterface::shape_deriv(), libMesh::FE< Dim, T >::shape_deriv(), libMesh::InfFE< Dim, T_radial, T_map >::shape_deriv(), libMesh::FEInterface::shape_deriv(), libMesh::FEInterface::shape_deriv(), libMesh::FEInterface::shape_derivs(), libMesh::FEInterface::shape_derivs(), libMesh::FEInterface::shape_second_deriv(), libMesh::FEInterface::shape_second_deriv(), libMesh::FE< Dim, T >::shape_second_deriv(), libMesh::FEInterface::shape_second_deriv(), libMesh::FEInterface::shape_second_deriv(), libMesh::FEInterface::shapes(), libMesh::FEInterface::shapes(), libMesh::FEInterface::side_nodal_soln(), unweighted_quadrature_order(), and libMesh::System::write_header().

p_refinement

bool libMesh::FEType::p_refinement

Whether or not the finite elements for this type increase their p refinement level on geometric elements of increased p level.

Definition at line 292 of file fe_type.h.

Referenced by libMesh::DofMap::_dof_indices(), libMesh::DofMap::_node_dof_indices(), libMesh::EquationSystems::build_discontinuous_solution_vector(), libMesh::EquationSystems::build_parallel_solution_vector(), libMesh::FEGenericBase< OutputType >::compute_proj_constraints(), libMesh::FEMContext::init_internal_data(), libMesh::DofMap::old_dof_indices(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::SortAndCopy::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectInteriors::operator()(), std::hash< libMesh::FEType >::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectVertices::operator()(), libMesh::GenericProjector< FFunctor, GFunctor, FValue, ProjectionAction >::ProjectSides::operator()(), operator<(), operator==(), libMesh::DofMap::should_p_refine(), and libMesh::DofMap::should_p_refine().

radial_family

FEFamily libMesh::FEType::radial_family

The type of approximation in radial direction.

Valid types are JACOBI_20_00, JACOBI_30_00, etc...

Definition at line 276 of file fe_type.h.

Referenced by libMesh::FEGenericBase< OutputType >::build_InfFE(), libMesh::FEInterface::ifem_nodal_soln(), libMesh::InfFE< Dim, T_radial, T_map >::InfFE(), std::hash< libMesh::FEType >::operator()(), operator<(), operator==(), libMesh::System::read_header(), and libMesh::System::write_header().

radial_order

OrderWrapper libMesh::FEType::radial_order

The approximation order in radial direction of the infinite element.

Definition at line 263 of file fe_type.h.

Referenced by libMesh::InfFE< Dim, T_radial, T_map >::compute_data(), libMesh::InfFE< Dim, T_radial, T_map >::compute_shape_indices(), libMesh::InfFE< Dim, T_radial, T_map >::compute_shape_indices(), libMesh::InfFE< Dim, T_radial, T_map >::n_dofs(), libMesh::InfFE< Dim, T_radial, T_map >::n_dofs_at_node(), libMesh::InfFE< Dim, T_radial, T_map >::n_dofs_at_node(), libMesh::InfFE< Dim, T_radial, T_map >::n_dofs_per_elem(), libMesh::InfFE< Dim, T_radial, T_map >::n_dofs_per_elem(), std::hash< libMesh::FEType >::operator()(), operator<(), operator==(), libMesh::System::read_header(), libMesh::InfFE< Dim, T_radial, T_map >::shape(), libMesh::InfFE< Dim, T_radial, T_map >::shape(), libMesh::InfFE< Dim, T_radial, T_map >::shape_deriv(), libMesh::InfFE< Dim, T_radial, T_map >::shape_deriv(), InfFERadialTest::testRefinement(), and libMesh::System::write_header().

---

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

• include/fe/fe_type.h
• src/fe/fe_type.C