A means to translate nlohmann json into c++ primitive data types and back; and stores then during computation. More...

#include <VRSettings.hpp>

Inheritance diagram for DNDS::CFV::VRSettings:

Collaboration diagram for DNDS::CFV::VRSettings:

Classes
struct	BaseSettings

struct	FunctionalSettings

Public Types
using	json = nlohmann::ordered_json

using	t_base = FiniteVolumeSettings

Public Types inherited from DNDS::CFV::FiniteVolumeSettings
using	json = nlohmann::ordered_json

Public Member Functions
DNDS_HOST	VRSettings ()=default

DNDS_HOST	VRSettings (int dim)

	DNDS_DECLARE_CONFIG (VRSettings)

void	WriteIntoJson (json &jsonSetting) const
	Backward-compatible write (used by Python bindings).

void	ParseFromJson (const json &jsonSetting)
	Backward-compatible read (used by Python bindings).

bool	intOrderVRIsSame () const

int	intOrderVRValue () const

bool	intOrderVRBCIsSame () const

int	intOrderVRBCValue () const

Public Member Functions inherited from DNDS::CFV::FiniteVolumeSettings
DNDS_DEVICE_CALLABLE	FiniteVolumeSettings ()=default

DNDS_DEVICE_CALLABLE	FiniteVolumeSettings (int dim)

	DNDS_DECLARE_CONFIG (FiniteVolumeSettings)

DNDS_HOST void	WriteIntoJson (json &jsonSetting) const
	Backward-compatible write (used by Python bindings and VRSettings).

DNDS_HOST void	ParseFromJson (const json &jsonSetting)
	Backward-compatible read (used by Python bindings and VRSettings).

Public Attributes
int	intOrderVR {-1}

int	intOrderVRBC {-2}
	integration degree for VR matrices, <0 means using intOrder

bool	cacheDiffBase = false
	integration degree for VR matrices on BC faces, -1 means using int Order, < -1 means using intOrderVRValue() (the same as intOrderVR)

uint8_t	cacheDiffBaseSize = UINT8_MAX
	if cache the base function values on each of the quadrature points

real	jacobiRelax = 1.0

bool	SORInstead = true
	VR SOR/Jacobi iteration relaxation factor.

real	smoothThreshold = 0.01
	use SOR instead of relaxed Jacobi iteration

real	WBAP_nStd = 10
	limiter's smooth indicator threshold

bool	normWBAP = false
	n used in WBAP limiters

int	limiterBiwayAlter = 0
	if switch to normWBAP

int	subs2ndOrder = 0
	0=wbap-L2-biway, 1=minmod-biway

int	subs2ndOrderGGScheme = 1
	0: vfv; 1: gauss rule; 2: least square; 11: GGMP;

real	svdTolerance = 0
	1: gauss rule using distance for interpolation; 0: no interpolation

real	bcWeight = 1
	tolerance used in svd

struct DNDS::CFV::VRSettings::BaseSettings	baseSettings

struct DNDS::CFV::VRSettings::FunctionalSettings	functionalSettings

Public Attributes inherited from DNDS::CFV::FiniteVolumeSettings
int	maxOrder {1}

int	intOrder {1}
	polynomial degree of reconstruction

bool	ignoreMeshGeometryDeficiency = false
	integration degree globally set

int	nIterCellSmoothScale = 15

Detailed Description

A means to translate nlohmann json into c++ primitive data types and back; and stores then during computation.

Definition at line 32 of file VRSettings.hpp.

Member Typedef Documentation

◆ json

using DNDS::CFV::VRSettings::json = nlohmann::ordered_json

Definition at line 34 of file VRSettings.hpp.

◆ t_base

using DNDS::CFV::VRSettings::t_base = FiniteVolumeSettings

Definition at line 35 of file VRSettings.hpp.

Constructor & Destructor Documentation

◆ VRSettings() [1/2]

DNDS_HOST DNDS::CFV::VRSettings::VRSettings ( )

default

◆ VRSettings() [2/2]

DNDS_HOST DNDS::CFV::VRSettings::VRSettings ( int dim )

inline

Definition at line 161 of file VRSettings.hpp.

Member Function Documentation

◆ DNDS_DECLARE_CONFIG()

DNDS::CFV::VRSettings::DNDS_DECLARE_CONFIG ( VRSettings )

inline

Definition at line 166 of file VRSettings.hpp.

Here is the call graph for this function:

◆ intOrderVRBCIsSame()

bool DNDS::CFV::VRSettings::intOrderVRBCIsSame ( ) const

inline

Definition at line 223 of file VRSettings.hpp.

Here is the call graph for this function:

◆ intOrderVRBCValue()

int DNDS::CFV::VRSettings::intOrderVRBCValue ( ) const

inline

Definition at line 231 of file VRSettings.hpp.

Here is the call graph for this function:

◆ intOrderVRIsSame()

bool DNDS::CFV::VRSettings::intOrderVRIsSame ( ) const

inline

Definition at line 220 of file VRSettings.hpp.

Here is the caller graph for this function:

◆ intOrderVRValue()

int DNDS::CFV::VRSettings::intOrderVRValue ( ) const

inline

Definition at line 221 of file VRSettings.hpp.

Here is the caller graph for this function:

◆ ParseFromJson()

void DNDS::CFV::VRSettings::ParseFromJson ( const json & jsonSetting )

inline

Backward-compatible read (used by Python bindings).

Definition at line 215 of file VRSettings.hpp.

Here is the call graph for this function:

◆ WriteIntoJson()

void DNDS::CFV::VRSettings::WriteIntoJson ( json & jsonSetting ) const

inline

Backward-compatible write (used by Python bindings).

Definition at line 209 of file VRSettings.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ baseSettings

struct DNDS::CFV::VRSettings::BaseSettings DNDS::CFV::VRSettings::baseSettings

◆ bcWeight

real DNDS::CFV::VRSettings::bcWeight = 1

tolerance used in svd

Definition at line 53 of file VRSettings.hpp.

◆ cacheDiffBase

bool DNDS::CFV::VRSettings::cacheDiffBase = false

integration degree for VR matrices on BC faces, -1 means using int Order, < -1 means using intOrderVRValue() (the same as intOrderVR)

Definition at line 39 of file VRSettings.hpp.

◆ cacheDiffBaseSize

uint8_t DNDS::CFV::VRSettings::cacheDiffBaseSize = UINT8_MAX

if cache the base function values on each of the quadrature points

Definition at line 40 of file VRSettings.hpp.

◆ functionalSettings

struct DNDS::CFV::VRSettings::FunctionalSettings DNDS::CFV::VRSettings::functionalSettings

◆ intOrderVR

int DNDS::CFV::VRSettings::intOrderVR {-1}

Definition at line 37 of file VRSettings.hpp.

◆ intOrderVRBC

int DNDS::CFV::VRSettings::intOrderVRBC {-2}

integration degree for VR matrices, <0 means using intOrder

Definition at line 38 of file VRSettings.hpp.

◆ jacobiRelax

real DNDS::CFV::VRSettings::jacobiRelax = 1.0

Definition at line 42 of file VRSettings.hpp.

◆ limiterBiwayAlter

int DNDS::CFV::VRSettings::limiterBiwayAlter = 0

if switch to normWBAP

Definition at line 48 of file VRSettings.hpp.

◆ normWBAP

bool DNDS::CFV::VRSettings::normWBAP = false

n used in WBAP limiters

Definition at line 47 of file VRSettings.hpp.

◆ smoothThreshold

real DNDS::CFV::VRSettings::smoothThreshold = 0.01

use SOR instead of relaxed Jacobi iteration

Definition at line 45 of file VRSettings.hpp.

◆ SORInstead

bool DNDS::CFV::VRSettings::SORInstead = true

VR SOR/Jacobi iteration relaxation factor.

Definition at line 43 of file VRSettings.hpp.

◆ subs2ndOrder

int DNDS::CFV::VRSettings::subs2ndOrder = 0

0=wbap-L2-biway, 1=minmod-biway

Definition at line 49 of file VRSettings.hpp.

◆ subs2ndOrderGGScheme

int DNDS::CFV::VRSettings::subs2ndOrderGGScheme = 1

0: vfv; 1: gauss rule; 2: least square; 11: GGMP;

Definition at line 50 of file VRSettings.hpp.

◆ svdTolerance

real DNDS::CFV::VRSettings::svdTolerance = 0

1: gauss rule using distance for interpolation; 0: no interpolation

Definition at line 51 of file VRSettings.hpp.

◆ WBAP_nStd

real DNDS::CFV::VRSettings::WBAP_nStd = 10

limiter's smooth indicator threshold

Definition at line 46 of file VRSettings.hpp.

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

/home/runner/work/DNDSR/DNDSR/src/CFV/VRSettings.hpp

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ json

◆ t_base

Constructor & Destructor Documentation

◆ VRSettings() [1/2]

◆ VRSettings() [2/2]

Member Function Documentation

◆ DNDS_DECLARE_CONFIG()

◆ intOrderVRBCIsSame()

◆ intOrderVRBCValue()

◆ intOrderVRIsSame()

◆ intOrderVRValue()

◆ ParseFromJson()

◆ WriteIntoJson()

Member Data Documentation

◆ baseSettings

◆ bcWeight

◆ cacheDiffBase

◆ cacheDiffBaseSize

◆ functionalSettings

◆ intOrderVR

◆ intOrderVRBC

◆ jacobiRelax

◆ limiterBiwayAlter

◆ normWBAP

◆ smoothThreshold

◆ SORInstead

◆ subs2ndOrder

◆ subs2ndOrderGGScheme

◆ svdTolerance

◆ WBAP_nStd