deal2lkit: A ToolKit library for Deal.II
ParsedGridRefinement Class Reference

A wrapper for refinement strategies. More...

#include <parsed_grid_refinement.h>

Inheritance diagram for ParsedGridRefinement:
ParameterAcceptor Subscriptor

Public Member Functions

 ParsedGridRefinement (const std::string &name="", const std::string &strategy="fraction", const double &top_parameter=.3, const double &bottom_parameter=.1, const unsigned int &max_cells=0, const unsigned int &order=2)
 Constructor. More...
 
virtual void declare_parameters (ParameterHandler &prm)
 Declare local parameters. More...
 
template<int dim, class Vector , int spacedim>
void mark_cells (const Vector &criteria, Triangulation< dim, spacedim > &tria) const
 Mark cells a the triangulation for refinement or coarsening, according to the given strategy applied to the supplied vector representing local error criteria. More...
 
- Public Member Functions inherited from ParameterAcceptor
 ParameterAcceptor (const std::string section_name="")
 The constructor adds derived classes to the list of acceptors. More...
 
virtual ~ParameterAcceptor ()
 The destructor sets to zero the pointer relative to this index, so that it is safe to destroy the mother class. More...
 
virtual void parse_parameters (ParameterHandler &prm)
 Parse the parameter file. More...
 
virtual void parse_parameters_call_back ()
 Parse parameter call back. More...
 
std::string get_section_name () const
 Return the section name of this class. More...
 
std::vector< std::string > get_section_path () const
 Travers all registered classes, and figure out what subsections we need to enter. More...
 
template<class T >
void add_parameter (ParameterHandler &prm, T *parameter, const std::string &entry, const std::string &default_value, const Patterns::PatternBase &pattern=Patterns::Anything(), const std::string &documentation=std::string())
 Add a parameter the given parameter list. More...
 
template<class T >
void add_parameter (T &parameter, const std::string &entry, const std::string &documentation=std::string(), ParameterHandler &prm=ParameterAcceptor::prm)
 Add a parameter to the global parameter handler ParameterAcceptor::prm. More...
 
void enter_my_subsection (ParameterHandler &prm)
 Make sure we enter the right subsection of the global parameter file. More...
 
void leave_my_subsection (ParameterHandler &prm)
 This function undoes what the enter_my_subsection() function did. More...
 
template<>
std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const double &)
 double More...
 
template<>
std::string to_string (const double &entry)
 
template<>
double to_type (const std::string &parameter)
 
template<>
std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const int &)
 int More...
 
template<>
std::string to_string (const int &entry)
 
template<>
int to_type (const std::string &parameter)
 
template<>
std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const unsigned int &)
 unsigned int More...
 
template<>
std::string to_string (const unsigned int &entry)
 
template<>
unsigned int to_type (const std::string &parameter)
 
template<>
std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const bool &)
 bool More...
 
template<>
std::string to_string (const bool &entry)
 
template<>
bool to_type (const std::string &parameter)
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&)
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&)
 
void subscribe (const char *identifier=0) const
 
void unsubscribe (const char *identifier=0) const
 
unsigned int n_subscriptions () const
 
void list_subscribers () const
 
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

std::string strategy
 Default expression of this function. More...
 
double top_parameter
 
double bottom_parameter
 
unsigned int max_cells
 
unsigned int order
 

Additional Inherited Members

- Static Public Member Functions inherited from ParameterAcceptor
static void initialize (const std::string filename="", const std::string outfilename="")
 Call declare_all_parameters(), read filename (if it is present as input parameter) and parse_all_parameters() on the static member prm. More...
 
static void clear ()
 Clear class list and global parameter file. More...
 
static void parse_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)
 Parse the given ParameterHandler. More...
 
static void log_info ()
 Print information about all stored classes. More...
 
static void declare_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)
 Initialize the ParameterHandler with all derived classes parameters.This function enters the subsection returned by get_section_name() for each derived class, and declares all parameters that were added using add_parameter(). More...
 
template<class T >
static std_cxx11::shared_ptr< Patterns::PatternBaseto_pattern (const T &)
 Given a class T, construct its default pattern to be used when declaring parameters. More...
 
template<class T >
static T to_type (const std::string &)
 Given a string, fill the value of the given parameter. More...
 
template<class T >
static std::string to_string (const T &)
 Given a parameter, return a string containing the given parameter. More...
 
- Static Public Member Functions inherited from Subscriptor
static::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)
 
static::ExceptionBase & ExcNoSubscriber (char *arg1, char *arg2)
 
- Static Public Attributes inherited from ParameterAcceptor
static ParameterHandler prm
 Static parameter. More...
 
- Protected Attributes inherited from ParameterAcceptor
const std::string section_name
 The subsection name for this class. More...
 

Detailed Description

A wrapper for refinement strategies.

Definition at line 40 of file parsed_grid_refinement.h.

Constructor & Destructor Documentation

§ ParsedGridRefinement()

ParsedGridRefinement::ParsedGridRefinement ( const std::string &  name = "",
const std::string &  strategy = "fraction",
const double &  top_parameter = .3,
const double &  bottom_parameter = .1,
const unsigned int &  max_cells = 0,
const unsigned int &  order = 2 
)

Constructor.

Definition at line 23 of file parsed_grid_refinement.cc.

Member Function Documentation

§ declare_parameters()

void ParsedGridRefinement::declare_parameters ( ParameterHandler prm)
virtual

Declare local parameters.

Reimplemented from ParameterAcceptor.

Definition at line 37 of file parsed_grid_refinement.cc.

§ mark_cells()

template<int dim, class Vector , int spacedim>
void ParsedGridRefinement::mark_cells ( const Vector criteria,
Triangulation< dim, spacedim > &  tria 
) const

Mark cells a the triangulation for refinement or coarsening, according to the given strategy applied to the supplied vector representing local error criteria.

Cells are only marked for refinement or coarsening. No refinement is actually performed. You need to call Triangulation::execute_coarsening_and_refinement() yourself.

Definition at line 128 of file parsed_grid_refinement.h.

Member Data Documentation

§ bottom_parameter

double ParsedGridRefinement::bottom_parameter
private

Definition at line 97 of file parsed_grid_refinement.h.

§ max_cells

unsigned int ParsedGridRefinement::max_cells
private

Definition at line 98 of file parsed_grid_refinement.h.

§ order

unsigned int ParsedGridRefinement::order
private

Definition at line 99 of file parsed_grid_refinement.h.

§ strategy

std::string ParsedGridRefinement::strategy
private

Default expression of this function.

"

Definition at line 95 of file parsed_grid_refinement.h.

§ top_parameter

double ParsedGridRefinement::top_parameter
private

Definition at line 96 of file parsed_grid_refinement.h.


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