Panzer  Version of the Day
Public Member Functions | Private Attributes | List of all members
panzer::WorksetDescriptor Class Reference

#include <Panzer_WorksetDescriptor.hpp>

Public Member Functions

 WorksetDescriptor (const std::string &eBlock)
 
 WorksetDescriptor (const std::string &eBlock, const std::string &sideset, bool sideAssembly)
 
 WorksetDescriptor (const WorksetDescriptor &src)
 Copy constructor. More...
 
std::string getElementBlock () const
 Get element block. More...
 
std::string getSideset () const
 Get the side set. More...
 
bool sideAssembly () const
 Expects side set assembly on volume. More...
 
bool useSideset () const
 This descriptor is for a side set. More...
 

Private Attributes

std::string elementBlock_
 Element block, required to be non-empty. More...
 
bool useSideset_
 Use the side set information or not. More...
 
std::string sideset_
 Side set, must be non-empty if useSideset_ is true. More...
 
bool sideAssembly_
 

Detailed Description

Class provides a simple description of the types of worksets that need to be constructed and used. This is a generalization of using strings and pairs of string to represent the element blocks and sidesets. It is primarily used in specifying the "domain" of the assembly algorithm, that is which elements will be used in the assembly process.

Definition at line 60 of file Panzer_WorksetDescriptor.hpp.

Constructor & Destructor Documentation

◆ WorksetDescriptor() [1/3]

panzer::WorksetDescriptor::WorksetDescriptor ( const std::string &  eBlock)
inline

Constructor specifying a lone element block.

Parameters
[in]eBlockName of the element block

Definition at line 67 of file Panzer_WorksetDescriptor.hpp.

◆ WorksetDescriptor() [2/3]

panzer::WorksetDescriptor::WorksetDescriptor ( const std::string &  eBlock,
const std::string &  sideset,
bool  sideAssembly 
)
inline

Constructor that defines a side set. Note that the specified sideset must be a non-empty string.

Parameters
[in]eBlockElement block that includes the side
[in]eBlockSide set that is being used
[in]sideAssemblyAre integration rules and basis functions evaluated on the side or on the volume of the element.

Definition at line 83 of file Panzer_WorksetDescriptor.hpp.

◆ WorksetDescriptor() [3/3]

panzer::WorksetDescriptor::WorksetDescriptor ( const WorksetDescriptor src)
inline

Copy constructor.

Definition at line 96 of file Panzer_WorksetDescriptor.hpp.

Member Function Documentation

◆ getElementBlock()

std::string panzer::WorksetDescriptor::getElementBlock ( ) const
inline

Get element block.

Definition at line 104 of file Panzer_WorksetDescriptor.hpp.

◆ getSideset()

std::string panzer::WorksetDescriptor::getSideset ( ) const
inline

Get the side set.

Definition at line 108 of file Panzer_WorksetDescriptor.hpp.

◆ sideAssembly()

bool panzer::WorksetDescriptor::sideAssembly ( ) const
inline

Expects side set assembly on volume.

Definition at line 112 of file Panzer_WorksetDescriptor.hpp.

◆ useSideset()

bool panzer::WorksetDescriptor::useSideset ( ) const
inline

This descriptor is for a side set.

Definition at line 116 of file Panzer_WorksetDescriptor.hpp.

Member Data Documentation

◆ elementBlock_

std::string panzer::WorksetDescriptor::elementBlock_
private

Element block, required to be non-empty.

Definition at line 122 of file Panzer_WorksetDescriptor.hpp.

◆ useSideset_

bool panzer::WorksetDescriptor::useSideset_
private

Use the side set information or not.

Definition at line 125 of file Panzer_WorksetDescriptor.hpp.

◆ sideset_

std::string panzer::WorksetDescriptor::sideset_
private

Side set, must be non-empty if useSideset_ is true.

Definition at line 128 of file Panzer_WorksetDescriptor.hpp.

◆ sideAssembly_

bool panzer::WorksetDescriptor::sideAssembly_
private

This indicates if side quadrature rules are constructed or volume rules are constructued. Ignored if useSideset_ is false.

Definition at line 134 of file Panzer_WorksetDescriptor.hpp.


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