operator()() const;
/**
- * Function to identify the presently running program.
+ * %Function to identify the presently running program.
*/
static const JobIdentifier &
get_dealjobid();
*
*
* @param column_name Name of the column to add;
- * @param custom_function Function that will be called to fill the given
+ * @param custom_function %Function that will be called to fill the given
* entry. You need to make sure that the scope of this function is valid
* up to the call to error_from_exact() or difference();
* @param compute_rate If set to true, then this column will be included in
*
* @endcode
*
- * Function constants is a collection of pairs in the form name=value,
+ * %Function constants is a collection of pairs in the form name=value,
* separated by commas, for example:
*
* @code
* container stores values that differ in size. A varying amount of data
* may be packed per cell, if for example the underlying ValueType of
* the VectorType container is a container itself.
- * @param[in] refinement_strategy Function deciding how data will be
- * stored on refined cells from its parent cell.
- * @param[in] coarsening_strategy Function deciding which data to store on
- * a cell whose children will get coarsened into.
+ * @param[in] refinement_strategy %Function deciding how data will be
+ * stored on refined cells from its parent cell.
+ * @param[in] coarsening_strategy %Function deciding which data to store
+ * on a cell whose children will get coarsened into.
*/
CellDataTransfer(
const parallel::distributed::Triangulation<dim, spacedim>
* container stores values that differ in size. A varying amount of data
* may be packed per cell, if for example the underlying ValueType of
* the VectorType container is a container itself.
- * @param[in] coarsening_strategy Function deciding which data to store on
- * a cell whose children will get coarsened into.
+ * @param[in] coarsening_strategy %Function deciding which data to store
+ * on a cell whose children will get coarsened into.
*
* @deprecated Use the above constructor instead.
*/
const bool transfer_variable_size_data;
/**
- * Function deciding how data will be stored on refined cells from its
+ * %Function deciding how data will be stored on refined cells from its
* parent cell.
*/
const std::function<std::vector<value_type>(
refinement_strategy;
/**
- * Function deciding on how to process data from children to be stored on
+ * %Function deciding on how to process data from children to be stored on
* the parent cell.
*/
const std::function<value_type(
get_hierarchy_sequence(const unsigned int fe_index = 0) const;
/**
- * Function returning the index of the finite element following the given
+ * %Function returning the index of the finite element following the given
* @p fe_index in hierarchy.
*
* By default, the index succeeding @p fe_index will be returned. If @p fe_index
next_in_hierarchy(const unsigned int fe_index) const;
/**
- * Function returning the index of the finite element preceding the given
+ * %Function returning the index of the finite element preceding the given
* @p fe_index in hierarchy.
*
* By default, the index preceding @p fe_index will be returned. If @p fe_index
finite_elements;
/**
- * Function returning the index of the finite element following the given
+ * %Function returning the index of the finite element following the given
* one in hierarchy.
*/
std::function<unsigned int(const typename hp::FECollection<dim, spacedim> &,
hierarchy_next;
/**
- * Function returning the index of the finite element preceding the given
+ * %Function returning the index of the finite element preceding the given
* one in hierarchy.
*/
std::function<unsigned int(const typename hp::FECollection<dim, spacedim> &,
};
/**
- * Function printing the name of a State.
+ * %Function printing the name of a State.
*/
inline const char *
state_name(State s)
};
/**
- * Function printing the name of a Property.
+ * %Function printing the name of a Property.
*/
inline const char *
property_name(const Property s)
std::string name;
/**
- * Function by which the base class's functions get to know what patches
+ * %Function by which the base class's functions get to know what patches
* they shall write to a file.
*/
virtual const std::vector<Patch> &
const MPI_Comm mpi_communicator;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is requested by the derived class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
const AdditionalData additional_data;
/**
- * Function that takes a Krylov Subspace Solver context object, and sets
+ * %Function that takes a Krylov Subspace Solver context object, and sets
* the type of solver that is appropriate for this class.
*/
virtual void
bool have_interface_matrices;
/**
- * Function which implements vmult_add (@p transpose = false) and
+ * %Function which implements vmult_add (@p transpose = false) and
* Tvmult_add (@p transpose = true).
*/
void
DynamicSparsityPattern & connectivity_blocks) const;
/**
- * Function to create coloring on the second layer within each
+ * %Function to create coloring on the second layer within each
* partition.
*/
void
std::vector<unsigned int> & partition_color_list);
/**
- * Function to create partitioning on the second layer within each
+ * %Function to create partitioning on the second layer within each
* partition.
*/
void
const MGLevelObject<MGTwoLevelTransfer<dim, VectorType>> &transfer;
/**
- * Function to initialize internal level vectors.
+ * %Function to initialize internal level vectors.
*/
const std::function<void(const unsigned int, VectorType &)>
initialize_dof_vector;
* @param[in] triangulation The triangulation on which all operations will
* happen. At the time when this constructor is called, the refinement
* in question has not happened yet.
- * @param[in] refinement_strategy Function deciding how data will be stored on
- * refined cells from its parent cell.
- * @param[in] coarsening_strategy Function deciding which data to store on
+ * @param[in] refinement_strategy %Function deciding how data will be stored
+ * on refined cells from its parent cell.
+ * @param[in] coarsening_strategy %Function deciding which data to store on
* a cell whose children will get coarsened into.
*/
CellDataTransfer(
triangulation;
/**
- * Function deciding how data will be stored on refined cells from its parent
+ * %Function deciding how data will be stored on refined cells from its parent
* cell.
*/
const std::function<std::vector<value_type>(
refinement_strategy;
/**
- * Function deciding on how to process data from children to be stored on the
+ * %Function deciding on how to process data from children to be stored on the
* parent cell.
*/
const std::function<value_type(
std::vector<Patch> patches;
/**
- * Function by which the base class's functions get to know what patches
+ * %Function by which the base class's functions get to know what patches
* they shall write to a file.
*/
virtual const std::vector<Patch> &
* @param strategy Solution strategy
* @param maximum_non_linear_iterations Maximum number of nonlinear
* iterations
- * @param function_tolerance Function norm stopping tolerance
+ * @param function_tolerance %Function norm stopping tolerance
* @param step_tolerance Scaled step stopping tolerance
*
* Newton parameters:
void *A_data;
/**
- * Function pointer declared by SUNDIALS to evaluate the matrix vector
+ * %Function pointer declared by SUNDIALS to evaluate the matrix vector
* product.
*/
ATimesFn a_times_fn;
void *P_data;
/**
- * Function pointer to a function that computes the preconditioner
+ * %Function pointer to a function that computes the preconditioner
* application.
*/
PSolveFn p_solve_fn;
projects / dealii.git / commitdiff