WARPXM v1.10.0
Loading...
Searching...
No Matches
WmICGenerator::WmICApplicator Class Reference

#include <wmicgenerator.h>

Public Types

enum  { WMICGENERATORSCHEME_MODAL = 1 , WMICGENERATORSCHEME_NODAL = 2 , WMICGENERATORSCHEME_FV = 3 }
 Identifies how initial conditions are generated from a given WmICFunction. More...
 

Public Member Functions

 WmICApplicator (WmICGenerator *parent)
 Create new WmICApplicator.
 
 ~WmICApplicator ()
 Destroy WmICApplicator.
 
void setup (const WxCryptSet &wxc)
 Setup the WmICApplicator from a cryptset and an application index.
 
void apply (const WmUnstructuredPatch &patch)
 Applies the initial condition to the variable for a given patch TODO: needs to work with any patch (structured and unstructured)
 
const WmVariableParser::componentList_tgetComponents () const
 Grabs the components used by this applicator.
 

Protected Attributes

WmICGenerator_parent
 
int _spatialScheme
 
int _spatialOrder
 
std::string _basisSetName
 
WmVariableParser::componentList_t _args
 
WmICFunction_f
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Identifies how initial conditions are generated from a given WmICFunction.

Enumerator
WMICGENERATORSCHEME_MODAL 
WMICGENERATORSCHEME_NODAL 
WMICGENERATORSCHEME_FV 

Constructor & Destructor Documentation

◆ WmICApplicator()

WmICGenerator::WmICApplicator::WmICApplicator ( WmICGenerator parent)

Create new WmICApplicator.

Parameters
parentParent WmICGenerator

◆ ~WmICApplicator()

WmICGenerator::WmICApplicator::~WmICApplicator ( )

Destroy WmICApplicator.

Member Function Documentation

◆ apply()

void WmICGenerator::WmICApplicator::apply ( const WmUnstructuredPatch patch)

Applies the initial condition to the variable for a given patch TODO: needs to work with any patch (structured and unstructured)

Parameters
patchUnstructured patch on which to apply initial condition

◆ getComponents()

const WmVariableParser::componentList_t & WmICGenerator::WmICApplicator::getComponents ( ) const
inline

Grabs the components used by this applicator.

Returns
list of components

◆ setup()

void WmICGenerator::WmICApplicator::setup ( const WxCryptSet wxc)

Setup the WmICApplicator from a cryptset and an application index.

Parameters
wxcCryptset to setup with
wxcappIndexCryptset to setup with

Member Data Documentation

◆ _args

WmVariableParser::componentList_t WmICGenerator::WmICApplicator::_args
protected

◆ _basisSetName

std::string WmICGenerator::WmICApplicator::_basisSetName
protected

◆ _f

WmICFunction* WmICGenerator::WmICApplicator::_f
protected

◆ _parent

WmICGenerator* WmICGenerator::WmICApplicator::_parent
protected

◆ _spatialOrder

int WmICGenerator::WmICApplicator::_spatialOrder
protected

◆ _spatialScheme

int WmICGenerator::WmICApplicator::_spatialScheme
protected

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