Commit 0c7829da authored by Fabian's avatar Fabian
Browse files

Spelling

parent f1c44c51
......@@ -70,7 +70,7 @@ namespace betl2 {
> dof_data_set_factory;
//! Define the data set which will be used
typedef typename dof_data_set_factory::dofTuple_t dofTuple_t;
//! Typedef for elements (codimension 0)
//! Typedef for elements (co-dimension 0)
typedef eth::grid::Entity< gridTraits_t, 0 > element_t;
private:
......@@ -86,7 +86,7 @@ namespace betl2 {
//! Forbid copies
DofDistributionPolicy( const DofDistributionPolicy& ) = delete;
//! Forbid assignemnts
//! Forbid assignments
DofDistributionPolicy& operator=( const DofDistributionPolicy& ) = delete;
//! Destructor
......@@ -268,12 +268,12 @@ namespace betl2 {
this -> allocate_( grid_view_factory );
// get the view
const auto gridView = grid_view_factory.getView( );
// the dimension defines defines the maximum codimension
// the dimension defines defines the maximum co-dimension
const int MAX_CODIM = gridTraits_t::dimMesh;
// define a counter and initialize with zero
size_type counter = 0;
// distribute dofs for MAX_CODIM, i.e., for the element's vertices (not nodes!!!)
// Note: this need not be done seperately but it doesn't really matter
// Note: this need not be done separately but it doesn't really matter
this -> distributeDofsOnVertices_( gridView, counter, febasis );
// distribute dofs for MAX_CODIM-1, ..., 0
typedef betl2::utils::static_iterate< MAX_CODIM-1, DofDistributor_,
......@@ -295,7 +295,7 @@ namespace betl2 {
// Loop over elements (CODIM = 0)
for( const auto& elem : fespace ) {
// resize vector on dofsOnElement
// Note: applyDim actually uses the dimension of an entity, not the codimension!
// Note: applyDim actually uses the dimension of an entity, not the co-dimension!
// Also, this is needed here since the reference type is needed as a
// template argument but may differ for each element at runtime
// (hybrid mesh).
......@@ -405,8 +405,8 @@ namespace betl2 {
const auto num_dofs_per_elem = febasis.multiplicity(entity);
// resize vector on dofsOnElement
// Note: It is done this way to accomodate for entities with
// different reference types but same codimension CODIM.
// Note: It is done this way to accommodate for entities with
// different reference types but same co-dimension CODIM.
// The necessary member function needs ret as a constexpr.
eth::base::ReferenceElements::template applyDim<
gridTraits_t::dimMesh-CODIM,
......
......@@ -407,7 +407,7 @@ namespace betl2 {
template< eth::base::RefElType REF >
class GDSHelper : public IGDSHelper {
private:
//! Vector for entities, but instead of entites there are vectors with indices.
//! Vector for entities, but instead of entities there are vectors with indices.
const indexSet_t* indexSet_;
std::vector< std::vector<dataType_t> > data_;
public:
......@@ -426,7 +426,7 @@ namespace betl2 {
data_.resize( indexSet_->size(REF) );
}
// Resize data vector with defaultValue is not implemented.
// This is justified due to the unkown length of new elements.
// This is justified due to the unknown length of new elements.
/*! @return a reference to data for an entity with given index.
......@@ -520,7 +520,7 @@ namespace betl2 {
// Resize helper.
// Starts resizing the no. of templates-1 element of the tuple Helper_
// and recursevly goes to the first (0) element.
// and recursively goes to the first (0) element.
// The class PAIR_ can be anything in this case.
//! @brief Recursively resizes Helper_ using the member variable indexSet_.
template<eth::base::RefElType PAIR_1,
......@@ -536,7 +536,7 @@ namespace betl2 {
}
// Returns true if the reference element type is supported.
// Goes recursively through all PAIRS_ argument and check's if they match
// Goes recursively through all PAIRS_ argument and checks if they match
// the given eth::base::RefElType type.
//! @brief Checks if the list of reference elements contain a reference element.
template<eth::base::RefElType RET_1, eth::base::RefElType RET_2,
......@@ -581,7 +581,7 @@ namespace betl2 {
return std::get<sizeof...(REFS)-1>(Helpers_).refElType == TYPE
? &std::get<sizeof...(REFS)-1>(Helpers_)
// The std::logic_error should never be thrown due to previous checks
: throw std::logic_error("An internal error in DataStruct occured.");
: throw std::logic_error("An internal error in DataStruct occurred.");
}
/*! @brief Finds the tuple element of Helper_ that matches a reference
......@@ -599,7 +599,7 @@ namespace betl2 {
return std::get<sizeof...(REFS)-1>(Helpers_).refElType == TYPE
? &std::get<sizeof...(REFS)-1>(Helpers_)
// The std::logic_error should never be thrown due to previous checks
: throw std::logic_error("An internal error in DataStruct occured.");
: throw std::logic_error("An internal error in DataStruct occurred.");
}
......
......@@ -50,7 +50,7 @@ namespace betl2 {
//------------------------------------------------------------------------
/*! @brief Layout of \ref DofDataSetFactory
*
* This is the specialised implemenation of \ref DofDataSetFactory
* This is the specialised implementation of \ref DofDataSetFactory
* for the 2 dimensional case. It is listed here for an overview
* of the provided functions and types. The other dimensions are
* analogue.
......@@ -90,7 +90,7 @@ namespace betl2 {
point_container_t* > dofTuple_t;
//! @brief Creates the tuple containing degrees of freedom for entites.
//! @brief Creates the tuple containing degrees of freedom for entities.
static void Create( const GRID_VIEW_FACTORY_T& grid_view_factory,
dofTuple_t& t )
{
......
......@@ -72,7 +72,7 @@ namespace betl2 {
* febasis.setMult(ent, 1);
* \endcode
* One can use the class \ref GridElementsIdentifier to retrieve subsets
* of all entities using gmsh's phyiscal tags in order to set different number
* of all entities using gmsh's physical tags in order to set different number
* of degrees of freedom in different regions of the mesh.
*
* The underlying implementation is done using \ref NumDofDataSetFactory.
......@@ -120,7 +120,7 @@ namespace betl2 {
/*! @brief Sets the number of degrees of freedom for an entity.
*
* @param ent Entity whose degrees of freedom are to be set.
* @param mult Number of degrees of freedom to be set (excluding subentites).
* @param mult Number of degrees of freedom to be set (excluding sub-entities).
*/
template< int CODIM >
inline void setMult(const eth::grid::Entity<gridTraits_t, CODIM>& ent,
......@@ -130,7 +130,7 @@ namespace betl2 {
/*! @return number of degrees of freedom associated with an entity
* (but not its subentites).
* (but not its sub-entities).
*
* @param ent Entity.
*/
......@@ -149,10 +149,10 @@ namespace betl2 {
*/
inline size_type numDofs(const eth::grid::Entity<gridTraits_t,0>& elem) const
{
// Get degrees of freedom for this element (without its subentities)
// Get degrees of freedom for this element (without its sub-entities)
size_type dofs = multiplicity(elem);
// Retrieve all degrees of freedom of the subentities of this element
// Retrieve all degrees of freedom of the sub-entities of this element
typedef betl2::utils::static_iterate< gridTraits_t::dimMesh-1,
GetDofs_,
const FEBasis&,
......@@ -170,7 +170,7 @@ namespace betl2 {
//! @cond
// Helper struct for retrieving the degrees of freedom of all entities
// given a codimension
// given a co-dimension
template< int CODIM >
struct GetDofs_
{
......@@ -178,9 +178,9 @@ namespace betl2 {
inline void operator()( const FEBasis& febasis, const ELEMENT_T& elem,
size_type& dofs) const
{
// Get number of subentities of this elment with codimension=CODIM
// Get number of sub-entities of this element with co-dimension=CODIM
const size_type numSubEnt = elem.template countSubEntities<CODIM+1>( );
// Loop over subentities and add their degrees of freedom
// Loop over sub-entities and add their degrees of freedom
for(size_type i = 0; i < numSubEnt; ++i)
dofs += febasis.multiplicity( *(elem.template subEntity<CODIM+1>(i)) );
}
......
......@@ -288,13 +288,13 @@ namespace betl2 {
}
/*! @return a vector with the local indices of filtered degrees of freedom for
* subentities with codimension CODIM.
* sub-entities with co-dimension CODIM.
*
* @tparam CODIM Codimension of which entities should be filtered.
* @tparam CODIM Co-dimension of which entities should be filtered.
* @param elem Element where indices should be filtered.
* @param intersectionIndex Index of entity (codimension=1) where indices
* @param intersectionIndex Index of entity (co-dimension=1) where indices
* should be filtered from.
* @note An intersection (in 2d) is an entity with codimension 1.
* @note An intersection (in 2d) is an entity with co-dimension 1.
*/
template< int CODIM >
inline
......
......@@ -28,9 +28,9 @@ namespace betl2 {
*
* This struct is used to filter indices of dofs from a given element.
* This is done via an Intersection index. The intersection index is the
* local index of a subentity with codimension 1.
* local index of a sub-entity with co-dimension 1.
*
* @tparam CODIM Codimension of subentities to be filtered.
* @tparam CODIM Co-dimension of sub-entities to be filtered.
* @tparam DIM Dimension of elements/mesh.
* @tparam FESPACE_REF_T Constant reference type to \ref FESpace.
*
......@@ -45,7 +45,7 @@ namespace betl2 {
/*! A function that filters degrees of freedom.
*
* @param ELEMENT_T& Element whose dofs should be filtered.
* @param int Index of subentity with codimension 1
* @param int Index of sub-entity with co-dimension 1
* whose specific dofs should be filtered
* @param FESPACE_REF_T Reference to FESpace
*
......@@ -86,7 +86,7 @@ namespace betl2 {
// Get the reference element type
const auto ret0 = e.refElType();
// Get local sub-entity nodes (of the entity (codim=1) with index
// Get local sub-entity nodes (of the entity (co-dim=1) with index
// intersectionIndex in element)
const auto localNodes = eth::base::ReferenceElements::
getSubEntityNodes( ret0, 1, intersectionIndex );
......@@ -128,7 +128,7 @@ namespace betl2 {
{
// get the reference element type from the the codim0-entity
const auto ret0 = e.refElType( );
// a typelist of all reference element types
// a type-list of all reference element types
typedef eth::base::AllRefElTypesList_t allRefElTypesList_t;
// instantiate the result
typedef std::vector< int > vector_t;
......@@ -190,7 +190,7 @@ namespace betl2 {
offset += fespace.getFEBasis().multiplicity(
*(e.template subEntity<codimFace>(i)) );
// get the intersection's subentity type
// get the intersection's sub-entity type
const eth::base::RefElType intersectionRet =
ret_t::getSubEntityType(codimFace, intersectionIndex);
......
......@@ -61,7 +61,7 @@ namespace betl2 {
*/
/*! @brief A wrapper for fe::FEBasis
*
* This class provides an wrapper for the previous impementation of the
* This class provides an wrapper for the previous implementation of the
* finite element basis in the case of a fixed number of degrees of freedom
* of entities with the same reference type for new implementations.
*
......@@ -159,7 +159,7 @@ namespace betl2 {
/*! @return the number of degrees of freedom solely associated with an
* entity and not any subentities.
* entity and not any sub-entities.
*
* @param entity Entity.
*/
......@@ -169,7 +169,7 @@ namespace betl2 {
return febasis_t::multiplicity(entity.refElType());
}
/*! @return the number of degrees of freedom solely associated with an
* entity and not any subentities. (constant version)
* entity and not any sub-entities. (constant version)
*
* @param entity Entity.
*/
......
......@@ -26,11 +26,11 @@
* static constexpr size_type multiplicity( );
*
* // Number of degrees of freedom associated
* // with a reference type including its subentities
* // with a reference type including its sub-entities
* template< eth::base::RefElType RET >
* static constexpr size_type numDofs( );
*
* // Runtime support for multplicity
* // Runtime support for multiplicity
* static size_type multiplicity( const eth::base::RefElType );
* // Runtime support for numDofs
* static size_type numDofs( const eth::base::RefElType );
......
......@@ -178,7 +178,7 @@ namespace betl2 {
//----------------------------------------------------------------------
//! @brief A mock base class that allows for non-templated pointers to
//! @brief A mock base class that allows for non-template pointers to
//! \ref StorageHelper.
class StorageHelperBase {};
// A note for developers: Those {} are needed (otherwise type is incomplete).
......@@ -269,7 +269,7 @@ namespace betl2 {
* match the given one.
*
* @note The return type is a pointer of the base class of StorageHelper.
* This is because we need a non-templated return type.
* This is because we need a non-template return type.
*
* @tparam REF The reference element type that is searched.
* @tparam RET_1 Reference element types to compare against.
......@@ -300,7 +300,7 @@ namespace betl2 {
* match the given one.
*
* @note The return type is a pointer of the base class of StorageHelper.
* This is because we need a non-templated return type.
* This is because we need a non-template return type.
*
* @tparam REF The reference element type that is searched.
* @tparam RET_1 Reference element types to compare against.
......
......@@ -43,7 +43,7 @@ namespace betl2 {
//------------------------------------------------------------------------
/*! @brief Layout of \ref NumDofDataSetFactory
*
* This is the specialised implemenation of \ref NumDofDataSetFactory
* This is the specialised implementation of \ref NumDofDataSetFactory
* for the 2 dimensional case. It is listed here for an overview
* of the provided functions and types. The other dimensions are
* analogue.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment