Loading [MathJax]/extensions/tex2jax.js
KratosMultiphysics
KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
List of all members
Kratos::ConvectionDiffusionSettings Class Reference

Convection diffusion settings. This class contains information to be used by the convection diffusion solver, all the variables that will be needed by the solver. More...

#include <convection_diffusion_settings.h>

Collaboration diagram for Kratos::ConvectionDiffusionSettings:

Public Member Functions

Type Definitions
 KRATOS_CLASS_POINTER_DEFINITION (ConvectionDiffusionSettings)
 Pointer definition of ConvectionDiffusionSettings. More...
 
Life Cycle
 ConvectionDiffusionSettings ()=default
 Default constructor. More...
 
 ConvectionDiffusionSettings (const ConvectionDiffusionSettings &rOther)
 
virtual ~ConvectionDiffusionSettings ()
 Destructor. More...
 
Operators
void SetDensityVariable (const Variable< double > &rvar)
 
const Variable< double > & GetDensityVariable () const
 
bool IsDefinedDensityVariable () const
 
void SetDiffusionVariable (const Variable< double > &rvar)
 
const Variable< double > & GetDiffusionVariable () const
 
bool IsDefinedDiffusionVariable () const
 
void SetUnknownVariable (const Variable< double > &rvar)
 
const Variable< double > & GetUnknownVariable () const
 
bool IsDefinedUnknownVariable () const
 
void SetVolumeSourceVariable (const Variable< double > &rvar)
 
const Variable< double > & GetVolumeSourceVariable () const
 
bool IsDefinedVolumeSourceVariable () const
 
void SetSurfaceSourceVariable (const Variable< double > &rvar)
 
const Variable< double > & GetSurfaceSourceVariable () const
 
bool IsDefinedSurfaceSourceVariable () const
 
void SetProjectionVariable (const Variable< double > &rvar)
 
const Variable< double > & GetProjectionVariable () const
 
bool IsDefinedProjectionVariable () const
 
void SetConvectionVariable (const Variable< array_1d< double, 3 > > &rvar)
 
const Variable< array_1d< double, 3 > > & GetConvectionVariable () const
 
bool IsDefinedConvectionVariable () const
 
void SetGradientVariable (const Variable< array_1d< double, 3 > > &rvar)
 
const Variable< array_1d< double, 3 > > & GetGradientVariable () const
 
bool IsDefinedGradientVariable () const
 
void SetMeshVelocityVariable (const Variable< array_1d< double, 3 > > &rvar)
 
const Variable< array_1d< double, 3 > > & GetMeshVelocityVariable () const
 
bool IsDefinedMeshVelocityVariable () const
 
void SetTransferCoefficientVariable (const Variable< double > &rvar)
 
const Variable< double > & GetTransferCoefficientVariable () const
 
bool IsDefinedTransferCoefficientVariable () const
 
void SetVelocityVariable (const Variable< array_1d< double, 3 > > &rvar)
 
const Variable< array_1d< double, 3 > > & GetVelocityVariable () const
 
bool IsDefinedVelocityVariable () const
 
void SetSpecificHeatVariable (const Variable< double > &rvar)
 
const Variable< double > & GetSpecificHeatVariable () const
 
bool IsDefinedSpecificHeatVariable () const
 
void SetReactionVariable (const Variable< double > &rvar)
 
const Variable< double > & GetReactionVariable () const
 
bool IsDefinedReactionVariable () const
 
void SetReactionGradientVariable (const Variable< array_1d< double, 3 >> &rVar)
 
const Variable< array_1d< double, 3 > > & GetReactionGradientVariable () const
 
bool IsDefinedReactionGradientVariable () const
 
Access

Assignment operator.

ConvectionDiffusionSettings & operator= (ConvectionDiffusionSettings const &rOther)
 
Input and output
virtual std::string Info () const
 Turn back information as a string. More...
 
virtual void PrintInfo (std::ostream &rOStream) const
 Print information about this object. More...
 
virtual void PrintData (std::ostream &rOStream) const
 Print object's data. More...
 

Serialization

class Serializer
 

Detailed Description

Convection diffusion settings. This class contains information to be used by the convection diffusion solver, all the variables that will be needed by the solver.

All the variables needed by any convection diffusion problem are included here. However, many problems do not require such a large amount of variables. For those cases, variables that are not defined will be set to either zero or one (depending on the variable) For this purpose, there are flags to ask whether a variable has been defined or not. For each variable, there are three main functions. SetVariableforXuse: we assign the variable for this use. When doing that we also set the flag that now this variable has been defined. GetVariableforXuse: we return the variable for this use. IsDefinedVariableforXuse: tells whether that variable has been defined or not.

Constructor & Destructor Documentation

◆ ConvectionDiffusionSettings() [1/2]

Kratos::ConvectionDiffusionSettings::ConvectionDiffusionSettings ( )
default

Default constructor.

◆ ConvectionDiffusionSettings() [2/2]

Kratos::ConvectionDiffusionSettings::ConvectionDiffusionSettings ( const ConvectionDiffusionSettings &  rOther)
inline

◆ ~ConvectionDiffusionSettings()

virtual Kratos::ConvectionDiffusionSettings::~ConvectionDiffusionSettings ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ GetConvectionVariable()

const Variable<array_1d<double,3> >& Kratos::ConvectionDiffusionSettings::GetConvectionVariable ( ) const
inline

◆ GetDensityVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetDensityVariable ( ) const
inline

◆ GetDiffusionVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetDiffusionVariable ( ) const
inline

◆ GetGradientVariable()

const Variable<array_1d<double,3> >& Kratos::ConvectionDiffusionSettings::GetGradientVariable ( ) const
inline

◆ GetMeshVelocityVariable()

const Variable<array_1d<double,3> >& Kratos::ConvectionDiffusionSettings::GetMeshVelocityVariable ( ) const
inline

◆ GetProjectionVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetProjectionVariable ( ) const
inline

◆ GetReactionGradientVariable()

const Variable<array_1d<double,3> >& Kratos::ConvectionDiffusionSettings::GetReactionGradientVariable ( ) const
inline

◆ GetReactionVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetReactionVariable ( ) const
inline

◆ GetSpecificHeatVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetSpecificHeatVariable ( ) const
inline

◆ GetSurfaceSourceVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetSurfaceSourceVariable ( ) const
inline

◆ GetTransferCoefficientVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetTransferCoefficientVariable ( ) const
inline

◆ GetUnknownVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetUnknownVariable ( ) const
inline

◆ GetVelocityVariable()

const Variable<array_1d<double,3> >& Kratos::ConvectionDiffusionSettings::GetVelocityVariable ( ) const
inline

◆ GetVolumeSourceVariable()

const Variable<double>& Kratos::ConvectionDiffusionSettings::GetVolumeSourceVariable ( ) const
inline

◆ Info()

virtual std::string Kratos::ConvectionDiffusionSettings::Info ( ) const
inlinevirtual

Turn back information as a string.

◆ IsDefinedConvectionVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedConvectionVariable ( ) const
inline

◆ IsDefinedDensityVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedDensityVariable ( ) const
inline

◆ IsDefinedDiffusionVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedDiffusionVariable ( ) const
inline

◆ IsDefinedGradientVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedGradientVariable ( ) const
inline

◆ IsDefinedMeshVelocityVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedMeshVelocityVariable ( ) const
inline

◆ IsDefinedProjectionVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedProjectionVariable ( ) const
inline

◆ IsDefinedReactionGradientVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedReactionGradientVariable ( ) const
inline

◆ IsDefinedReactionVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedReactionVariable ( ) const
inline

◆ IsDefinedSpecificHeatVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedSpecificHeatVariable ( ) const
inline

◆ IsDefinedSurfaceSourceVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedSurfaceSourceVariable ( ) const
inline

◆ IsDefinedTransferCoefficientVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedTransferCoefficientVariable ( ) const
inline

◆ IsDefinedUnknownVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedUnknownVariable ( ) const
inline

◆ IsDefinedVelocityVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedVelocityVariable ( ) const
inline

◆ IsDefinedVolumeSourceVariable()

bool Kratos::ConvectionDiffusionSettings::IsDefinedVolumeSourceVariable ( ) const
inline

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::ConvectionDiffusionSettings::KRATOS_CLASS_POINTER_DEFINITION ( ConvectionDiffusionSettings  )

Pointer definition of ConvectionDiffusionSettings.

◆ operator=()

ConvectionDiffusionSettings& Kratos::ConvectionDiffusionSettings::operator= ( ConvectionDiffusionSettings const &  rOther)
inline

◆ PrintData()

virtual void Kratos::ConvectionDiffusionSettings::PrintData ( std::ostream &  rOStream) const
inlinevirtual

Print object's data.

◆ PrintInfo()

virtual void Kratos::ConvectionDiffusionSettings::PrintInfo ( std::ostream &  rOStream) const
inlinevirtual

Print information about this object.

◆ SetConvectionVariable()

void Kratos::ConvectionDiffusionSettings::SetConvectionVariable ( const Variable< array_1d< double, 3 > > &  rvar)
inline

◆ SetDensityVariable()

void Kratos::ConvectionDiffusionSettings::SetDensityVariable ( const Variable< double > &  rvar)
inline

◆ SetDiffusionVariable()

void Kratos::ConvectionDiffusionSettings::SetDiffusionVariable ( const Variable< double > &  rvar)
inline

◆ SetGradientVariable()

void Kratos::ConvectionDiffusionSettings::SetGradientVariable ( const Variable< array_1d< double, 3 > > &  rvar)
inline

◆ SetMeshVelocityVariable()

void Kratos::ConvectionDiffusionSettings::SetMeshVelocityVariable ( const Variable< array_1d< double, 3 > > &  rvar)
inline

◆ SetProjectionVariable()

void Kratos::ConvectionDiffusionSettings::SetProjectionVariable ( const Variable< double > &  rvar)
inline

◆ SetReactionGradientVariable()

void Kratos::ConvectionDiffusionSettings::SetReactionGradientVariable ( const Variable< array_1d< double, 3 >> &  rVar)
inline

◆ SetReactionVariable()

void Kratos::ConvectionDiffusionSettings::SetReactionVariable ( const Variable< double > &  rvar)
inline

◆ SetSpecificHeatVariable()

void Kratos::ConvectionDiffusionSettings::SetSpecificHeatVariable ( const Variable< double > &  rvar)
inline

◆ SetSurfaceSourceVariable()

void Kratos::ConvectionDiffusionSettings::SetSurfaceSourceVariable ( const Variable< double > &  rvar)
inline

◆ SetTransferCoefficientVariable()

void Kratos::ConvectionDiffusionSettings::SetTransferCoefficientVariable ( const Variable< double > &  rvar)
inline

◆ SetUnknownVariable()

void Kratos::ConvectionDiffusionSettings::SetUnknownVariable ( const Variable< double > &  rvar)
inline

◆ SetVelocityVariable()

void Kratos::ConvectionDiffusionSettings::SetVelocityVariable ( const Variable< array_1d< double, 3 > > &  rvar)
inline

◆ SetVolumeSourceVariable()

void Kratos::ConvectionDiffusionSettings::SetVolumeSourceVariable ( const Variable< double > &  rvar)
inline

Friends And Related Function Documentation

◆ Serializer

friend class Serializer
friend
The documentation for this class was generated from the following files:
Generated on Sat Feb 3 2024 02:51:26 for KratosMultiphysics by doxygen 1.9.1