Lethe Open-Source Library version 1.2.0
Developer Guide
Loading...
Searching...
No Matches
BoundaryConditions::TracerBoundaryConditions< dim > Class Template Reference

#include <tracer_boundary_conditions.h>

Inheritance diagram for BoundaryConditions::TracerBoundaryConditions< dim >:
[legend]

Public Member Functions

void declare_default_entry (ParameterHandler &prm, types::boundary_id default_boundary_id)
void declare_parameters (ParameterHandler &prm, unsigned int number_of_boundary_conditions)
void parse_boundary (ParameterHandler &prm)
void parse_parameters (ParameterHandler &prm)

Public Attributes

std::map< types::boundary_id, std::shared_ptr< Functions::ParsedFunction< dim > > > tracer
Public Attributes inherited from BoundaryConditions::BoundaryConditions< TracerBoundaryType >
std::map< types::boundary_id, TracerBoundaryType > type
unsigned int number_of_boundary_conditions
bool time_dependent
Parameters::PeriodicBoundaries periodic_boundaries

Detailed Description

template<int dim>
class BoundaryConditions::TracerBoundaryConditions< dim >

This class manages the boundary conditions for Tracer solver It introduces the boundary functions and declares the boundary conditions coherently.

Definition at line 46 of file tracer_boundary_conditions.h.

Member Function Documentation

◆ declare_default_entry()

template<int dim>
void BoundaryConditions::TracerBoundaryConditions< dim >::declare_default_entry ( ParameterHandler & prm,
types::boundary_id default_boundary_id )

Declare the default parameters for one tracer boundary condition.

Parameters
[in,out]prmThe parameter handler object.
[in]default_boundary_idThe default mesh boundary id.

Definition at line 26 of file tracer_boundary_conditions.cc.

References declare_enum_entry(), BoundaryConditions::outlet, and BoundaryConditions::tracer_boundary_types.

◆ declare_parameters()

template<int dim>
void BoundaryConditions::TracerBoundaryConditions< dim >::declare_parameters ( ParameterHandler & prm,
unsigned int number_of_boundary_conditions )

Declare the tracer boundary condition parameters.

Parameters
[in,out]prmThe parameter handler object.
[in]number_of_boundary_conditionsThe number of boundary conditions to declare.

Definition at line 63 of file tracer_boundary_conditions.cc.

References declare_default_entry(), and BoundaryConditions::BoundaryConditions< TracerBoundaryType >::number_of_boundary_conditions.

◆ parse_boundary()

◆ parse_parameters()

template<int dim>
void BoundaryConditions::TracerBoundaryConditions< dim >::parse_parameters ( ParameterHandler & prm)

Parse the tracer boundary condition parameters.

Parameters
[in]prmThe parameter handler object.

Definition at line 146 of file tracer_boundary_conditions.cc.

References BoundaryConditions::BoundaryConditions< TracerBoundaryType >::number_of_boundary_conditions, parse_boundary(), and BoundaryConditions::BoundaryConditions< TracerBoundaryType >::time_dependent.

Member Data Documentation

◆ tracer

template<int dim>
std::map<types::boundary_id, std::shared_ptr<Functions::ParsedFunction<dim> > > BoundaryConditions::TracerBoundaryConditions< dim >::tracer

Definition at line 51 of file tracer_boundary_conditions.h.


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