This function takes any source app and writes source to a specified output variable. More...

#include <get_source.h>

Inheritance diagram for wxm::apps::functions::arbitrary::GetSource:

Detailed Description

This function takes any source app and writes source to a specified output variable.

Can specify any subset of the source vector to be written to the output variable.

See also: Warpy constructor: warpy::apps::functions::arbitrary::get_source

Public Member Functions
	GetSource ()
	Constructor.

	~GetSource () override
	Destructor.

void	setup (const WxCryptSet &wxc) override
	Setup.

const std::vector< int > &	getInputVariableIndexes (int flag) const override
	Grab input variable indices.

const std::vector< int > &	getAuxiliaryVariableIndexes (int flag) const override
	Grab aux variable indices.

const std::vector< int > &	getOutputVariableIndexes (int flag) const override
	Grab output variable indices.

void	evaluate_function (const real q, const real aux, const solverVariables_t pSV, real result) const override
	Redefinition of the function evaluator.

Public Member Functions inherited from WmApplication
	WmApplication ()

virtual	~WmApplication ()=default

virtual void	setup (const WxCryptSet &wxc)

virtual const std::vector< int > &	getAuxiliaryVariableIndexes (int flag=WMAPPLICATIONFLAG_NONE) const

virtual const std::vector< int > &	getCrossVariableIndexes (int flag=WMAPPLICATIONFLAG_NONE) const

const std::vector< std::string > &	getBoundaryNames () const

bool	isOnBoundary (const std::string &boundaryName) const

bool	has (int flag) const

virtual real	numerical_flux (const real q_l, const real q_r, const real aux_l, const real aux_r, const solverVariables_t pFV, real numericalFlux) const

virtual real	internal_flux (const real q, const real aux, const solverVariables_t *pSV, std::vector< std::vector< real > > &internalFlux) const

virtual real	source (const real q, const real aux, const elementGeometry_t pEG, real source) const

virtual void	bc_q (const real q_in, const real aux_in, const real aux_out, const solverVariables_t pFV, real *q_out) const
	Boundary Condition Application which sets the boundary condition on ghost nodes.

virtual real	bcNumericalFlux (const real q_l, const real q_r, const real aux_l, const real aux_r, const solverVariables_t pFV, real numericalFlux) const

virtual void	conserved_to_primitive (const real q, const real aux, real *w) const

virtual void	primitive_to_conserved (const real w, const real aux, real *q) const

virtual void	evaluate_function (const real q, const real aux, const solverVariables_t pSV, real result) const

virtual void	bc_q_kinetic (const real q_in, const real aux_in, const solverVariables_t pFV, real q_out) const

std::shared_ptr< std::string >	app_name ()

virtual const std::vector< int > &	getInputVariableIndexes (int flag=0) const

virtual const std::vector< int > &	getOutputVariableIndexes (int flag=0) const

Protected Attributes
std::unique_ptr< WmApplication >	_source_app
	Source app.

std::vector< int >	_input_indices
	Indices of source app input variable.

std::vector< int >	_aux_indices
	Indices of source app aux variable.

std::vector< int >	_source_output_indices
	Indicies of the source app output.

std::vector< int >	_needed_indices
	Relative indicies of the source app output to copy.

std::vector< int >	_output_indices
	Indices of output variable.

std::vector< real >	_source

Protected Attributes inherited from WmApplication
std::string	_app_name

WxLogStream	_debStrm

std::vector< int >	_allowedFlags

std::vector< std::string >	_onBoundaries

Additional Inherited Members
Public Types inherited from WmApplication
typedef Application_Variable	WmApplication_Variable

typedef std::map< std::string, std::string >	replaceMap_t

Static Public Attributes inherited from wxm::app_base
static std::vector< int >	empty

Protected Member Functions inherited from wxm::app_base
virtual	~app_base ()=default

Constructor & Destructor Documentation

◆ GetSource()

wxm::apps::functions::arbitrary::GetSource::GetSource ( )

Constructor.

◆ ~GetSource()

wxm::apps::functions::arbitrary::GetSource::~GetSource ( )

override

Destructor.

Member Function Documentation

◆ evaluate_function()

void wxm::apps::functions::arbitrary::GetSource::evaluate_function	(	const real *	q,
		const real *	aux,
		const solverVariables_t *	pSV,
		real *	result
	)		const

overridevirtual

Redefinition of the function evaluator.

Parameters

const	q - input variable
const	aux - auxiliary variable
const	pSV - solver variable structure
result	- output variable

Reimplemented from WmApplication.

◆ getAuxiliaryVariableIndexes()

const std::vector< int > & wxm::apps::functions::arbitrary::GetSource::getAuxiliaryVariableIndexes ( int flag ) const

inlineoverridevirtual

Grab aux variable indices.

Parameters

int	flag - usually flag is given like flux type but usually not checked

Returns: vector of auxiliary variable indices

Reimplemented from WmApplication.

◆ getInputVariableIndexes()

const std::vector< int > & wxm::apps::functions::arbitrary::GetSource::getInputVariableIndexes ( int flag ) const

inlineoverridevirtual

Grab input variable indices.

Parameters

int	flag - usually flag is given like flux type but usually not checked

Returns: vector of input variable indices

Reimplemented from wxm::app_base.

◆ getOutputVariableIndexes()

const std::vector< int > & wxm::apps::functions::arbitrary::GetSource::getOutputVariableIndexes ( int flag ) const

inlineoverridevirtual

Grab output variable indices.

Parameters

int	flag - usually flag is given like flux type but usually not checked

Returns: vector of output variable indices

Reimplemented from wxm::app_base.

◆ setup()

void wxm::apps::functions::arbitrary::GetSource::setup ( const WxCryptSet & wxc )

overridevirtual

Setup.

Parameters

WxCryptSet object

Reimplemented from WmApplication.

Member Data Documentation

◆ _aux_indices

std::vector<int> wxm::apps::functions::arbitrary::GetSource::_aux_indices

protected

Indices of source app aux variable.

◆ _input_indices

std::vector<int> wxm::apps::functions::arbitrary::GetSource::_input_indices

protected

Indices of source app input variable.

◆ _needed_indices

std::vector<int> wxm::apps::functions::arbitrary::GetSource::_needed_indices

protected

Relative indicies of the source app output to copy.

Must be same size as _output_indices

◆ _output_indices

std::vector<int> wxm::apps::functions::arbitrary::GetSource::_output_indices

protected

Indices of output variable.

◆ _source

std::vector<real> wxm::apps::functions::arbitrary::GetSource::_source

mutableprotected

◆ _source_app

std::unique_ptr<WmApplication> wxm::apps::functions::arbitrary::GetSource::_source_app

protected

Source app.

◆ _source_output_indices

std::vector<int> wxm::apps::functions::arbitrary::GetSource::_source_output_indices

protected

Indicies of the source app output.

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

src/apps/function_evaluators/arbitrary/get_source.h

Detailed Description

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ GetSource()

◆ ~GetSource()

Member Function Documentation

◆ evaluate_function()

◆ getAuxiliaryVariableIndexes()

◆ getInputVariableIndexes()

◆ getOutputVariableIndexes()

◆ setup()

Member Data Documentation

◆ _aux_indices

◆ _input_indices

◆ _needed_indices

◆ _output_indices

◆ _source

◆ _source_app

◆ _source_output_indices