Finite Volume Solver  prototype
A framework to build finite volume solvers for the AG Klein at the Freie Universität Berlin.
Public Member Functions | Public Attributes | List of all members
fub::amrex::BoundarySet Struct Reference

This class manages a list of boundary conditions which get applied in the order in which they are stored. More...

#include <BoundarySet.hpp>

Public Member Functions

void FillBoundary (::amrex::MultiFab &mf, const GriddingAlgorithm &gridding, int level)
 Apply each condition on the specified MultiFab mf. More...
 
void FillBoundary (::amrex::MultiFab &mf, const GriddingAlgorithm &gridding, int level, Direction dir)
 Apply each condition on the specified MultiFab mf but only in direction dir. More...
 

Public Attributes

std::vector< AnyBoundaryConditionconditions
 This vector stores all boundary conditions. More...
 

Detailed Description

This class manages a list of boundary conditions which get applied in the order in which they are stored.

Member Function Documentation

◆ FillBoundary() [1/2]

void fub::amrex::BoundarySet::FillBoundary ( ::amrex::MultiFab &  mf,
const GriddingAlgorithm gridding,
int  level 
)

Apply each condition on the specified MultiFab mf.

Parameters
[in,out]mfThe MultiFab that will be filled.
[in]griddingThe GriddingAlgorithm will serve as a context.
[in]levelThe level number which is associated with the specified MultiFab mf.
Exceptions
Exceptionswill be propogated to the user if any of the stored boundary conditions throws an exception.
Precondition
mf is defined with the same (BoxArray, DistributionMapping) as defined in the gridding algorithm at refinement level level.

◆ FillBoundary() [2/2]

void fub::amrex::BoundarySet::FillBoundary ( ::amrex::MultiFab &  mf,
const GriddingAlgorithm gridding,
int  level,
Direction  dir 
)

Apply each condition on the specified MultiFab mf but only in direction dir.

Parameters
[in,out]mfThe MultiFab that will be filled.
[in]griddingThe GriddingAlgorithm will serve as a context.
[in]levelThe level number which is associated with the specified MultiFab mf.
[in]dirThe direction in which the physical boundary shall be filled.
Exceptions
Exceptionswill be propogated to the user if any of the stored boundary conditions throws an exception.
Precondition
mf is defined with the same (BoxArray, DistributionMapping) as defined in the gridding algorithm at refinement level level.

Member Data Documentation

◆ conditions

std::vector<AnyBoundaryCondition> fub::amrex::BoundarySet::conditions

This vector stores all boundary conditions.


The documentation for this struct was generated from the following file: