HyperreductionConfiguration Class Reference

Discrete Empirical Interpolation Method settings. More...

#include <HyperreductionConfiguration.H>

Public Member Functions
const Foam::word &	HRMethod () const
const Foam::word &	ECPAlgo () const
void	setHRMethod (const Foam::word &method)
void	setECPAlgo (const Foam::word &algo)
const Foam::word &	HRSnapshotsField () const
const Foam::word &	HRInterpolatedField () const
const bool &	interpFieldCentered () const
void	setHRInterpolatedField (const Foam::word &field)
void	setHRSnapshotsField (const Foam::word &field)
void	set_interpFieldCentered (const bool &b)
const Foam::label &	nMagicPoints () const
const Foam::List< Foam::label > &	magicPoints () const
const Foam::List< Foam::label > &	localMagicPoints () const
const Foam::fvMesh &	get_submesh () const
void	setNMagicPoints (Foam::label n)
void	setMagicPoints (const Foam::List< Foam::label > &points)
void	setLocalMagicPoints (const Foam::List< Foam::label > &points)
void	set_submesh (Foam::fvMesh &s)
const float &	Ck () const
const float &	Ce () const
void	setCk (float ck)
void	setCe (float ce)
const Foam::word &	folderDEIM () const
void	setFolderDEIM (const Foam::word &folder)
const Foam::PtrList< Foam::volTensorField > &	deformationTensorOnMagicNeighborhoods () const
const Foam::PtrList< Foam::volTensorField > &	deformationTensorOnMagicPoints () const
const Foam::PtrList< Foam::volVectorField > &	tracerGradOnMagicNeighborhoods () const
const Foam::PtrList< Foam::volVectorField > &	tracerGradOnMagicPoints () const
void	setDeformationTensorOnMagicNeighborhoods (Foam::PtrList< Foam::volTensorField > &defT, Foam::label nModes)
void	setDeformationTensorOnMagicPoints (Foam::PtrList< Foam::volTensorField > &defT, Foam::label nModes)
void	setTracerGradOnMagicNeighborhoods (Foam::PtrList< Foam::volVectorField > &defT, Foam::label nModes)
void	setTracerGradOnMagicPoints (Foam::PtrList< Foam::volVectorField > &defT, Foam::label nModes)
const Eigen::MatrixXd &	K_DEIM () const
const Eigen::MatrixXd &	projectedK_DEIM () const
const Eigen::MatrixXd &	projectedMK_DEIM () const
void	setK_DEIM (const Eigen::MatrixXd &K)
void	setProjectedK_DEIM (const Eigen::MatrixXd &K)
void	setProjectedMK_DEIM (const Eigen::MatrixXd &MK)
const Eigen::Tensor< double, 3 > &	xiOnMagicPts () const
const Eigen::Tensor< double, 3 > &	M_xiOnMagicPts () const
void	setXiOnMagicPts (const Eigen::Tensor< double, 3 > &xi)
void	setM_XiOnMagicPts (const Eigen::Tensor< double, 3 > &M_xi)
const Foam::volVectorField *	meanVectorDEIM () const
const Foam::volScalarField *	meanScalarDEIM () const
const Foam::volVectorField *	meanVectorDEIMMagic () const
const Foam::volScalarField *	meanScalarDEIMMagic () const
void	setMeanVectorDEIM (const Foam::volVectorField &mean)
void	setMeanScalarDEIM (const Foam::volScalarField &mean)
void	setMeanVectorDEIMMagic (const Foam::volVectorField &mean)
void	setMeanScalarDEIMMagic (const Foam::volScalarField &mean)
const Eigen::VectorXd	deltaWeight () const
const Foam::volScalarField &	get_magicDelta () const
void	setDeltaWeight (const Eigen::VectorXd &dw)
void	set_magicDelta (const Foam::volScalarField &mD)
void	initializeHyperreduction (std::unique_ptr< PODConfiguration > &PODConfig)
void	initializeReducedField (const Foam::word origField, std::unique_ptr< PODConfiguration > &PODConfig)
void	addReducedFieldToPOD (const Foam::word &nameToReplace, const Foam::word &modifiedFieldName, std::unique_ptr< PODConfiguration > &PODConfig)
Foam::word	createReducedFieldName (const Foam::word &fieldName, std::unique_ptr< PODConfiguration > &PODConfig)

Detailed Description

Discrete Empirical Interpolation Method settings.

Manages magic points, interpolation matrices, and DEIM-specific fields for hyper-reduction of nonlinear terms.

Definition at line 22 of file HyperreductionConfiguration.H.

Constructor & Destructor Documentation

HyperreductionConfiguration()

HyperreductionConfiguration::HyperreductionConfiguration ( )

inline

Definition at line 25 of file HyperreductionConfiguration.H.

Member Function Documentation

addReducedFieldToPOD()

void HyperreductionConfiguration::addReducedFieldToPOD	(	const Foam::word &	nameToReplace,
		const Foam::word &	modifiedFieldName,
		std::unique_ptr< PODConfiguration > &	PODConfig )

Definition at line 175 of file HyperreductionConfiguration.C.

Ce()

const float & HyperreductionConfiguration::Ce ( ) const

inline

Definition at line 60 of file HyperreductionConfiguration.H.

Ck()

const float & HyperreductionConfiguration::Ck ( ) const

inline

Definition at line 59 of file HyperreductionConfiguration.H.

createReducedFieldName()

Foam::word HyperreductionConfiguration::createReducedFieldName	(	const Foam::word &	fieldName,
		std::unique_ptr< PODConfiguration > &	PODConfig )

Definition at line 188 of file HyperreductionConfiguration.C.

deformationTensorOnMagicNeighborhoods()

const Foam::PtrList< Foam::volTensorField > & HyperreductionConfiguration::deformationTensorOnMagicNeighborhoods ( ) const

inline

Definition at line 69 of file HyperreductionConfiguration.H.

deformationTensorOnMagicPoints()

const Foam::PtrList< Foam::volTensorField > & HyperreductionConfiguration::deformationTensorOnMagicPoints ( ) const

inline

Definition at line 73 of file HyperreductionConfiguration.H.

deltaWeight()

const Eigen::VectorXd HyperreductionConfiguration::deltaWeight ( ) const

inline

Definition at line 119 of file HyperreductionConfiguration.H.

ECPAlgo()

const Foam::word & HyperreductionConfiguration::ECPAlgo ( ) const

inline

Definition at line 33 of file HyperreductionConfiguration.H.

folderDEIM()

const Foam::word & HyperreductionConfiguration::folderDEIM ( ) const

inline

Definition at line 65 of file HyperreductionConfiguration.H.

get_magicDelta()

const Foam::volScalarField & HyperreductionConfiguration::get_magicDelta ( ) const

inline

Definition at line 120 of file HyperreductionConfiguration.H.

get_submesh()

const Foam::fvMesh & HyperreductionConfiguration::get_submesh ( ) const

inline

Definition at line 51 of file HyperreductionConfiguration.H.

HRInterpolatedField()

const Foam::word & HyperreductionConfiguration::HRInterpolatedField ( ) const

inline

Definition at line 40 of file HyperreductionConfiguration.H.

HRMethod()

const Foam::word & HyperreductionConfiguration::HRMethod ( ) const

inline

Definition at line 32 of file HyperreductionConfiguration.H.

HRSnapshotsField()

const Foam::word & HyperreductionConfiguration::HRSnapshotsField ( ) const

inline

Definition at line 39 of file HyperreductionConfiguration.H.

initializeHyperreduction()

void HyperreductionConfiguration::initializeHyperreduction

(

std::unique_ptr< PODConfiguration > &

PODConfig

)

Definition at line 72 of file HyperreductionConfiguration.C.

initializeReducedField()

void HyperreductionConfiguration::initializeReducedField	(	const Foam::word	origField,
		std::unique_ptr< PODConfiguration > &	PODConfig )

Definition at line 165 of file HyperreductionConfiguration.C.

interpFieldCentered()

const bool & HyperreductionConfiguration::interpFieldCentered ( ) const

inline

Definition at line 41 of file HyperreductionConfiguration.H.

K_DEIM()

const Eigen::MatrixXd & HyperreductionConfiguration::K_DEIM ( ) const

inline

Definition at line 92 of file HyperreductionConfiguration.H.

localMagicPoints()

const Foam::List< Foam::label > & HyperreductionConfiguration::localMagicPoints ( ) const

inline

Definition at line 50 of file HyperreductionConfiguration.H.

M_xiOnMagicPts()

const Eigen::Tensor< double, 3 > & HyperreductionConfiguration::M_xiOnMagicPts ( ) const

inline

Definition at line 102 of file HyperreductionConfiguration.H.

magicPoints()

const Foam::List< Foam::label > & HyperreductionConfiguration::magicPoints ( ) const

inline

Definition at line 49 of file HyperreductionConfiguration.H.

meanScalarDEIM()

const Foam::volScalarField * HyperreductionConfiguration::meanScalarDEIM ( ) const

inline

Definition at line 109 of file HyperreductionConfiguration.H.

meanScalarDEIMMagic()

const Foam::volScalarField * HyperreductionConfiguration::meanScalarDEIMMagic ( ) const

inline

Definition at line 111 of file HyperreductionConfiguration.H.

meanVectorDEIM()

const Foam::volVectorField * HyperreductionConfiguration::meanVectorDEIM ( ) const

inline

Definition at line 108 of file HyperreductionConfiguration.H.

meanVectorDEIMMagic()

const Foam::volVectorField * HyperreductionConfiguration::meanVectorDEIMMagic ( ) const

inline

Definition at line 110 of file HyperreductionConfiguration.H.

nMagicPoints()

const Foam::label & HyperreductionConfiguration::nMagicPoints ( ) const

inline

Definition at line 48 of file HyperreductionConfiguration.H.

projectedK_DEIM()

const Eigen::MatrixXd & HyperreductionConfiguration::projectedK_DEIM ( ) const

inline

Definition at line 93 of file HyperreductionConfiguration.H.

projectedMK_DEIM()

const Eigen::MatrixXd & HyperreductionConfiguration::projectedMK_DEIM ( ) const

inline

Definition at line 94 of file HyperreductionConfiguration.H.

set_interpFieldCentered()

void HyperreductionConfiguration::set_interpFieldCentered ( const bool & b )

inline

Definition at line 45 of file HyperreductionConfiguration.H.

set_magicDelta()

void HyperreductionConfiguration::set_magicDelta

(

const Foam::volScalarField &

mD

)

Definition at line 67 of file HyperreductionConfiguration.C.

set_submesh()

void HyperreductionConfiguration::set_submesh ( Foam::fvMesh & s )

inline

Definition at line 56 of file HyperreductionConfiguration.H.

setCe()

void HyperreductionConfiguration::setCe ( float ce )

inline

Definition at line 62 of file HyperreductionConfiguration.H.

setCk()

void HyperreductionConfiguration::setCk ( float ck )

inline

Definition at line 61 of file HyperreductionConfiguration.H.

setDeformationTensorOnMagicNeighborhoods()

void HyperreductionConfiguration::setDeformationTensorOnMagicNeighborhoods	(	Foam::PtrList< Foam::volTensorField > &	defT,
		Foam::label	nModes )

Definition at line 24 of file HyperreductionConfiguration.C.

setDeformationTensorOnMagicPoints()

void HyperreductionConfiguration::setDeformationTensorOnMagicPoints	(	Foam::PtrList< Foam::volTensorField > &	defT,
		Foam::label	nModes )

Definition at line 33 of file HyperreductionConfiguration.C.

setDeltaWeight()

void HyperreductionConfiguration::setDeltaWeight

(

const Eigen::VectorXd &

dw

)

Definition at line 62 of file HyperreductionConfiguration.C.

setECPAlgo()

void HyperreductionConfiguration::setECPAlgo ( const Foam::word & algo )

inline

Definition at line 36 of file HyperreductionConfiguration.H.

setFolderDEIM()

void HyperreductionConfiguration::setFolderDEIM ( const Foam::word & folder )

inline

Definition at line 66 of file HyperreductionConfiguration.H.

setHRInterpolatedField()

void HyperreductionConfiguration::setHRInterpolatedField ( const Foam::word & field )

inline

Definition at line 43 of file HyperreductionConfiguration.H.

setHRMethod()

void HyperreductionConfiguration::setHRMethod ( const Foam::word & method )

inline

Definition at line 35 of file HyperreductionConfiguration.H.

setHRSnapshotsField()

void HyperreductionConfiguration::setHRSnapshotsField ( const Foam::word & field )

inline

Definition at line 44 of file HyperreductionConfiguration.H.

setK_DEIM()

void HyperreductionConfiguration::setK_DEIM ( const Eigen::MatrixXd & K )

inline

Definition at line 96 of file HyperreductionConfiguration.H.

setLocalMagicPoints()

void HyperreductionConfiguration::setLocalMagicPoints ( const Foam::List< Foam::label > & points )

inline

Definition at line 55 of file HyperreductionConfiguration.H.

setM_XiOnMagicPts()

void HyperreductionConfiguration::setM_XiOnMagicPts ( const Eigen::Tensor< double, 3 > & M_xi )

inline

Definition at line 105 of file HyperreductionConfiguration.H.

setMagicPoints()

void HyperreductionConfiguration::setMagicPoints ( const Foam::List< Foam::label > & points )

inline

Definition at line 54 of file HyperreductionConfiguration.H.

setMeanScalarDEIM()

void HyperreductionConfiguration::setMeanScalarDEIM

(

const Foam::volScalarField &

mean

)

Definition at line 47 of file HyperreductionConfiguration.C.

setMeanScalarDEIMMagic()

void HyperreductionConfiguration::setMeanScalarDEIMMagic

(

const Foam::volScalarField &

mean

)

Definition at line 57 of file HyperreductionConfiguration.C.

setMeanVectorDEIM()

void HyperreductionConfiguration::setMeanVectorDEIM

(

const Foam::volVectorField &

mean

)

Definition at line 42 of file HyperreductionConfiguration.C.

setMeanVectorDEIMMagic()

void HyperreductionConfiguration::setMeanVectorDEIMMagic

(

const Foam::volVectorField &

mean

)

Definition at line 52 of file HyperreductionConfiguration.C.

setNMagicPoints()

void HyperreductionConfiguration::setNMagicPoints ( Foam::label n )

inline

Definition at line 53 of file HyperreductionConfiguration.H.

setProjectedK_DEIM()

void HyperreductionConfiguration::setProjectedK_DEIM ( const Eigen::MatrixXd & K )

inline

Definition at line 97 of file HyperreductionConfiguration.H.

setProjectedMK_DEIM()

void HyperreductionConfiguration::setProjectedMK_DEIM ( const Eigen::MatrixXd & MK )

inline

Definition at line 98 of file HyperreductionConfiguration.H.

setTracerGradOnMagicNeighborhoods()

void HyperreductionConfiguration::setTracerGradOnMagicNeighborhoods	(	Foam::PtrList< Foam::volVectorField > &	defT,
		Foam::label	nModes )

Definition at line 6 of file HyperreductionConfiguration.C.

setTracerGradOnMagicPoints()

void HyperreductionConfiguration::setTracerGradOnMagicPoints	(	Foam::PtrList< Foam::volVectorField > &	defT,
		Foam::label	nModes )

Definition at line 15 of file HyperreductionConfiguration.C.

setXiOnMagicPts()

void HyperreductionConfiguration::setXiOnMagicPts ( const Eigen::Tensor< double, 3 > & xi )

inline

Definition at line 104 of file HyperreductionConfiguration.H.

tracerGradOnMagicNeighborhoods()

const Foam::PtrList< Foam::volVectorField > & HyperreductionConfiguration::tracerGradOnMagicNeighborhoods ( ) const

inline

Definition at line 77 of file HyperreductionConfiguration.H.

tracerGradOnMagicPoints()

const Foam::PtrList< Foam::volVectorField > & HyperreductionConfiguration::tracerGradOnMagicPoints ( ) const

inline

Definition at line 81 of file HyperreductionConfiguration.H.

xiOnMagicPts()

const Eigen::Tensor< double, 3 > & HyperreductionConfiguration::xiOnMagicPts ( ) const

inline

Definition at line 101 of file HyperreductionConfiguration.H.

---

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

• /github/workspace/src/ITHACA_CORE/ITHACAstream/HyperreductionConfiguration.H
• /github/workspace/src/ITHACA_CORE/ITHACAstream/HyperreductionConfiguration.C