WARPXM v1.10.0
Loading...
Searching...
No Matches
WmFunctionApplicator::applicator_t Class Reference

#include <wmfunctionapplicator.h>

Classes

class  components_t
 

Public Types

enum  { WMFUNCTIONAPPLICATOR_MODAL = 1 , WMFUNCTIONAPPLICATOR_NODAL = 2 , WMFUNCTIONAPPLICATOR_FV = 3 , WMFUNCTIONAPPLICATOR_NODAL_KINETIC = 4 }
 Identifies how initial conditions are generated from a given WmICFunction. More...
 

Public Member Functions

 applicator_t (WmFunctionApplicator *parent)
 Create new applicator_t.
 
 ~applicator_t ()
 Destroy applicator_t.
 
void setup (const WxCryptSet &wxc)
 Setup the applicator_t 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)
 

Protected Attributes

WmFunctionApplicator_parent
 Parent function applicator.
 
int _spatialScheme
 Spatial scheme.
 
int _spatialOrder
 Spatial order.
 
std::string _basisSetName
 Name of the basis set.
 
components_t _components
 List of variables - TODO: move variables_t out of WmTimeIntegration.
 
WmICFunction_function
 Function to apply.
 
std::string _phase_space_order
 
std::vector< int > _vspace_nelems
 
int _vspace_dims
 
std::vector< real_vspace_minimums
 
std::vector< real_vspace_dv
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Identifies how initial conditions are generated from a given WmICFunction.

Enumerator
WMFUNCTIONAPPLICATOR_MODAL 
WMFUNCTIONAPPLICATOR_NODAL 
WMFUNCTIONAPPLICATOR_FV 
WMFUNCTIONAPPLICATOR_NODAL_KINETIC 

Constructor & Destructor Documentation

◆ applicator_t()

WmFunctionApplicator::applicator_t::applicator_t ( WmFunctionApplicator parent)

Create new applicator_t.

Parameters
parentParent WmFunctionApplicator

◆ ~applicator_t()

WmFunctionApplicator::applicator_t::~applicator_t ( )

Destroy applicator_t.

Member Function Documentation

◆ apply()

void WmFunctionApplicator::applicator_t::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

◆ setup()

void WmFunctionApplicator::applicator_t::setup ( const WxCryptSet wxc)

Setup the applicator_t from a cryptset and an application index.

Parameters
wxcCryptset to setup with
wxcappIndexCryptset to setup with

Member Data Documentation

◆ _basisSetName

std::string WmFunctionApplicator::applicator_t::_basisSetName
protected

Name of the basis set.

◆ _components

components_t WmFunctionApplicator::applicator_t::_components
protected

List of variables - TODO: move variables_t out of WmTimeIntegration.

◆ _function

WmICFunction* WmFunctionApplicator::applicator_t::_function
protected

Function to apply.

◆ _parent

WmFunctionApplicator* WmFunctionApplicator::applicator_t::_parent
protected

Parent function applicator.

◆ _phase_space_order

std::string WmFunctionApplicator::applicator_t::_phase_space_order
protected

◆ _spatialOrder

int WmFunctionApplicator::applicator_t::_spatialOrder
protected

Spatial order.

◆ _spatialScheme

int WmFunctionApplicator::applicator_t::_spatialScheme
protected

Spatial scheme.

◆ _vspace_dims

int WmFunctionApplicator::applicator_t::_vspace_dims
protected

◆ _vspace_dv

std::vector<real> WmFunctionApplicator::applicator_t::_vspace_dv
protected

◆ _vspace_minimums

std::vector<real> WmFunctionApplicator::applicator_t::_vspace_minimums
protected

◆ _vspace_nelems

std::vector<int> WmFunctionApplicator::applicator_t::_vspace_nelems
protected

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