Parameter configuration for a ReferenceCrossSection. More...

#include <reference_cross_section.h>

Inheritance diagram for ReferenceCrossSectionParameters< dim, spacedim, n_components >:

Public Member Functions
	ReferenceCrossSectionParameters ()
	Constructor that registers parameters.

Public Member Functions inherited from ParameterAcceptor
	ParameterAcceptor (const std::string &section_name="")

unsigned int	get_acceptor_id () const

virtual	~ParameterAcceptor () override

virtual void	declare_parameters (ParameterHandler &prm)

virtual void	parse_parameters (ParameterHandler &prm)

std::string	get_section_name () const

std::vector< std::string >	get_section_path () const

void	add_parameter (const std::string &entry, ParameterType &parameter, const std::string &documentation="", ParameterHandler &prm_=prm, const Patterns::PatternBase &pattern=*Patterns::Tools::Convert< ParameterType >::to_pattern())

void	enter_subsection (const std::string &subsection)

void	leave_subsection ()

void	enter_my_subsection (ParameterHandler &prm)

void	leave_my_subsection (ParameterHandler &prm)

void	serialize (Archive &ar, const unsigned int version)

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

Public Member Functions inherited from EnableObserverPointer
	EnableObserverPointer ()

	EnableObserverPointer (const EnableObserverPointer &)

	EnableObserverPointer (EnableObserverPointer &&) noexcept

virtual	~EnableObserverPointer ()

EnableObserverPointer &	operator= (const EnableObserverPointer &)

EnableObserverPointer &	operator= (EnableObserverPointer &&) noexcept

void	serialize (Archive &ar, const unsigned int version)

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

unsigned int	n_subscriptions () const

void	list_subscribers (StreamType &stream) const

void	list_subscribers () const

Public Attributes
unsigned int	refinement_level = 1
	Refinement level of the mesh.

std::string	inclusion_type = "hyper_ball"
	Geometric type of inclusion ("hyper_ball", etc.).

unsigned int	inclusion_degree = 0
	Degree of the polynomial basis for inclusion.

std::vector< unsigned int >	selected_coefficients
	List of selected coefficient indices for reduced modeling.

Public Attributes inherited from ParameterAcceptor
boost::signals2::signal< void()>	declare_parameters_call_back

boost::signals2::signal< void()>	parse_parameters_call_back

Additional Inherited Members
Static Public Member Functions inherited from ParameterAcceptor
static void	initialize (const std::string &filename="", const std::string &output_filename="", const ParameterHandler::OutputStyle output_style_for_output_filename=ParameterHandler::Short, ParameterHandler &prm=ParameterAcceptor::prm, const ParameterHandler::OutputStyle output_style_for_filename=ParameterHandler::DefaultStyle)

static void	initialize (std::istream &input_stream, ParameterHandler &prm=ParameterAcceptor::prm)

static void	clear ()

static void	parse_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)

static void	declare_all_parameters (ParameterHandler &prm=ParameterAcceptor::prm)

static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Static Public Member Functions inherited from EnableObserverPointer
static ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Static Public Attributes inherited from ParameterAcceptor
static ParameterHandler	prm

Protected Attributes inherited from ParameterAcceptor
const std::string	section_name

std::vector< std::string >	subsections

Detailed Description

template<int dim, int spacedim = dim, int n_components = 1>
class ReferenceCrossSectionParameters< dim, spacedim, n_components >

Parameter configuration for a ReferenceCrossSection.

This structure holds all parameters required to set up a ReferenceCrossSection object, including refinement level, inclusion type, polynomial degree, and selected coefficients.

Template Parameters

dim	The intrinsic dimension of the reference domain.
spacedim	The embedding space dimension.
n_components	Number of components per field variable.

Definition at line 61 of file reference_cross_section.h.

Constructor & Destructor Documentation

◆ ReferenceCrossSectionParameters()

template<int dim, int spacedim, int n_components>

ReferenceCrossSectionParameters< dim, spacedim, n_components >::ReferenceCrossSectionParameters ( )

Constructor that registers parameters.

Definition at line 316 of file reference_cross_section.cc.

References ParameterAcceptor::add_parameter(), inclusion_degree, inclusion_type, ParameterAcceptor::ParameterAcceptor(), refinement_level, and selected_coefficients.

Member Data Documentation

◆ inclusion_degree

template<int dim, int spacedim = dim, int n_components = 1>

unsigned int ReferenceCrossSectionParameters< dim, spacedim, n_components >::inclusion_degree = 0

Degree of the polynomial basis for inclusion.

Definition at line 73 of file reference_cross_section.h.

Referenced by ReferenceCrossSectionParameters().

◆ inclusion_type

template<int dim, int spacedim = dim, int n_components = 1>

std::string ReferenceCrossSectionParameters< dim, spacedim, n_components >::inclusion_type = "hyper_ball"

Geometric type of inclusion ("hyper_ball", etc.).

Definition at line 70 of file reference_cross_section.h.

Referenced by ReferenceCrossSectionParameters().

◆ refinement_level

template<int dim, int spacedim = dim, int n_components = 1>

unsigned int ReferenceCrossSectionParameters< dim, spacedim, n_components >::refinement_level = 1

Refinement level of the mesh.

Definition at line 67 of file reference_cross_section.h.

Referenced by ReferenceCrossSectionParameters().

◆ selected_coefficients

template<int dim, int spacedim = dim, int n_components = 1>

std::vector<unsigned int> ReferenceCrossSectionParameters< dim, spacedim, n_components >::selected_coefficients

mutable

List of selected coefficient indices for reduced modeling.

Definition at line 76 of file reference_cross_section.h.

Referenced by ReferenceCrossSectionParameters().

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

/github/workspace/include/reference_cross_section.h
/github/workspace/source/reference_cross_section.cc

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ReferenceCrossSectionParameters()

Member Data Documentation

◆ inclusion_degree

◆ inclusion_type

◆ refinement_level

◆ selected_coefficients