formulations.rans_formulation.RansFormulation Class Reference

Collaboration diagram for formulations.rans_formulation.RansFormulation:

Public Member Functions
def	__init__ (self, base_computing_model_part, settings)
	RansFormulation base class. More...
def	GetParameters (self)
	Returns parameters used in this formulation. More...
def	GetDomainSize (self)
	Returns domain size. More...
def	AddRansFormulation (self, formulation)
	Adds another RansFormulation to current formulation creating a list of formulations. More...
def	AddProcess (self, process)
	Adds a RansFormulationProcess to current RansFormulation. More...
def	AddVariables (self)
	Recursively calls AddVariables methods of existing formulations in this formulaton. More...
def	AddDofs (self)
	Recursively calls AddDofs methods of existing formulations in this formulaton. More...
def	PrepareModelPart (self)
	Recursively calls PrepareModelPart methods of existing formulations in this formulaton. More...
def	Clear (self)
	Recursively calls Clear methods of existing formulations in this formulaton and clears strategy. More...
def	Check (self)
	Recursively calls Check methods of existing formulations, processes and strategy in this formulaton. More...
def	Initialize (self)
	Recursively calls Initialize methods of existing formulations, processes and strategy in this formulaton. More...
def	InitializeSolutionStep (self)
	Recursively calls InitializeSolutionStep methods of existing formulations, processes and strategy in this formulaton. More...
def	SolveCouplingStep (self)
	Solves current formulation. More...
def	ExecuteBeforeCouplingSolveStep (self)
	Recursively calls ExecuteBeforeCouplingSolveStep methods of existing formulations in this formulaton. More...
def	ExecuteAfterCouplingSolveStep (self)
	Recursively calls ExecuteAfterCouplingSolveStep methods of existing formulations in this formulaton. More...
def	FinalizeSolutionStep (self)
	Recursively calls FinalizeSolutionStep methods of existing formulations, processes and strategy in this formulaton. More...
def	Finalize (self)
	Recursively calls Finalize methods of existing formulations and processes in this formulaton. More...
def	GetMinimumBufferSize (self)
	Recursively calculate minimum buffer size required by all formulations. More...
def	IsBufferInitialized (self)
	Check whether enough buffer is initialized to solve current formulation and its child formulations. More...
def	IsConverged (self)
	Recursively checks whether all formulations are converged. More...
def	GetMoveMeshFlag (self)
	Returns move mesh flag. More...
def	SetCommunicator (self, communicator)
	Sets the communicator for MPI use. More...
def	GetCommunicator (self)
	Get the communicator for MPI use. More...
def	IsPeriodic (self)
	Checks whether current formulations are solved with periodic conditions. More...
def	SetIsPeriodic (self, value)
	Sets periodicity recursively for all formulations. More...
def	SetTimeSchemeSettings (self, settings)
	Sets time scheme settings recursively for all formulations. More...
def	GetTimeSchemeSettings (self)
	Returns time scheme settings. More...
def	SetWallFunctionSettings (self, settings)
def	GetWallFunctionSettings (self)
	Returns wall function settings. More...
def	GetBaseModelPart (self)
	Returns base model part used in the formulation. More...
def	GetComputingModelPart (self)
	Returns computing model part used in the formulation. More...
def	SetMaxCouplingIterations (self, max_iterations)
	Sets max coupling iterations. More...
def	GetMaxCouplingIterations (self)
	Returns maxmum number of coupling iterations used in this formulation. More...
def	SetConstants (self, settings)
	Recursively sets constants in the formulations. More...
def	GetRansFormulationsList (self)
	Returns list of formulations in this formulation. More...
def	GetProcessList (self)
	Returns list of processes used in this formulation. More...
def	GetModelPart (self)
	Returns the model part used for solving current formulation (if a strategy is used only.) More...
def	GetStrategy (self)
	Returns strategy used in this formulation, if used any. More...
def	GetInfo (self)
	Recursively identify formulations being used. More...

Constructor & Destructor Documentation

__init__()

def formulations.rans_formulation.RansFormulation.__init__	(		self,
			base_computing_model_part,
			settings
	)

RansFormulation base class.

    This class is the base class for formulations used in RANSApplication. A single leaf formulation
    is responsible for solving for one variable only. RansFormulations can be added to another RansFormulation
    creating coupled hierarchical formulation. Then this base RansFormulations solves them recursively according
    to the addition order.

    Args:
        base_computing_model_part (Kratos.ModelPart): Base model part, which is copied to create solvers for given formulation
        settings (Kratos.Parameters): Settings to be used in this formulation

Member Function Documentation

AddDofs()

def formulations.rans_formulation.RansFormulation.AddDofs

(

self

)

Recursively calls AddDofs methods of existing formulations in this formulaton.

AddProcess()

def formulations.rans_formulation.RansFormulation.AddProcess	(		self,
			process
	)

Adds a RansFormulationProcess to current RansFormulation.

    Args:
        process (Kratos.RANSApplication.RansFormulationProcess): RansFormulationProcess to be added to current formulation

AddRansFormulation()

def formulations.rans_formulation.RansFormulation.AddRansFormulation	(		self,
			formulation
	)

Adds another RansFormulation to current formulation creating a list of formulations.

    Args:
        formulation (RansFormulation): Formulation to be added

AddVariables()

def formulations.rans_formulation.RansFormulation.AddVariables

(

self

)

Recursively calls AddVariables methods of existing formulations in this formulaton.

Check()

def formulations.rans_formulation.RansFormulation.Check

(

self

)

Recursively calls Check methods of existing formulations, processes and strategy in this formulaton.

Clear()

def formulations.rans_formulation.RansFormulation.Clear

(

self

)

Recursively calls Clear methods of existing formulations in this formulaton and clears strategy.

ExecuteAfterCouplingSolveStep()

def formulations.rans_formulation.RansFormulation.ExecuteAfterCouplingSolveStep

(

self

)

Recursively calls ExecuteAfterCouplingSolveStep methods of existing formulations in this formulaton.

ExecuteBeforeCouplingSolveStep()

def formulations.rans_formulation.RansFormulation.ExecuteBeforeCouplingSolveStep

(

self

)

Recursively calls ExecuteBeforeCouplingSolveStep methods of existing formulations in this formulaton.

Finalize()

def formulations.rans_formulation.RansFormulation.Finalize

(

self

)

Recursively calls Finalize methods of existing formulations and processes in this formulaton.

FinalizeSolutionStep()

def formulations.rans_formulation.RansFormulation.FinalizeSolutionStep

(

self

)

Recursively calls FinalizeSolutionStep methods of existing formulations, processes and strategy in this formulaton.

GetBaseModelPart()

def formulations.rans_formulation.RansFormulation.GetBaseModelPart

(

self

)

Returns base model part used in the formulation.

    Returns:
        Kratos.ModelPart: Base model part used in the formulation

GetCommunicator()

def formulations.rans_formulation.RansFormulation.GetCommunicator

(

self

)

Get the communicator for MPI use.

    Returns:
        Kratos.Communicator: Communicator used in the model part

GetComputingModelPart()

def formulations.rans_formulation.RansFormulation.GetComputingModelPart

(

self

)

Returns computing model part used in the formulation.

    Returns:
        Kratos.ModelPart: Computing model part used in the formulation

GetDomainSize()

def formulations.rans_formulation.RansFormulation.GetDomainSize

(

self

)

Returns domain size.

GetInfo()

def formulations.rans_formulation.RansFormulation.GetInfo

(

self

)

Recursively identify formulations being used.

    Returns:
        str: Information of all the formulations

GetMaxCouplingIterations()

def formulations.rans_formulation.RansFormulation.GetMaxCouplingIterations

(

self

)

Returns maxmum number of coupling iterations used in this formulation.

    Returns:
        int: Maximum number of coupling iterations

GetMinimumBufferSize()

def formulations.rans_formulation.RansFormulation.GetMinimumBufferSize

(

self

)

Recursively calculate minimum buffer size required by all formulations.

    Returns:
        int: Minimum buffer size

GetModelPart()

def formulations.rans_formulation.RansFormulation.GetModelPart

(

self

)

Returns the model part used for solving current formulation (if a strategy is used only.)

    Returns:
        Kratos.ModelPart: Model part used for solving current formulation

GetMoveMeshFlag()

def formulations.rans_formulation.RansFormulation.GetMoveMeshFlag

(

self

)

Returns move mesh flag.

    Returns:
        bool: True if mesh move, False if not

GetParameters()

def formulations.rans_formulation.RansFormulation.GetParameters

(

self

)

Returns parameters used in this formulation.

    Returns:
        Kratos.Parameters: Parameters of this formulation

GetProcessList()

def formulations.rans_formulation.RansFormulation.GetProcessList

(

self

)

Returns list of processes used in this formulation.

    Returns:
        List(Kratos.RANSApplication.RansFormulationProcess): List of rans formulation processes in this formulation

GetRansFormulationsList()

def formulations.rans_formulation.RansFormulation.GetRansFormulationsList

(

self

)

Returns list of formulations in this formulation.

    Returns:
        List(RansFormulation): List of formulations in this formulation

GetStrategy()

def formulations.rans_formulation.RansFormulation.GetStrategy

(

self

)

Returns strategy used in this formulation, if used any.

    Returns:
        Kratos.ImplicitSolvingStrategy: Strategy used in this formulation, None if not used.

GetTimeSchemeSettings()

def formulations.rans_formulation.RansFormulation.GetTimeSchemeSettings

(

self

)

Returns time scheme settings.

    Returns:
        Kratos.Parameters: Time scheme settings used for formulations

GetWallFunctionSettings()

def formulations.rans_formulation.RansFormulation.GetWallFunctionSettings

(

self

)

Returns wall function settings.

    Returns:
        Kratos.Parameters: Wall function settings used for formulations

Initialize()

def formulations.rans_formulation.RansFormulation.Initialize

(

self

)

Recursively calls Initialize methods of existing formulations, processes and strategy in this formulaton.

InitializeSolutionStep()

def formulations.rans_formulation.RansFormulation.InitializeSolutionStep

(

self

)

Recursively calls InitializeSolutionStep methods of existing formulations, processes and strategy in this formulaton.

IsBufferInitialized()

def formulations.rans_formulation.RansFormulation.IsBufferInitialized

(

self

)

Check whether enough buffer is initialized to solve current formulation and its child formulations.

    Returns:
        bool: True if enough steps are initialized, False otherwise

IsConverged()

def formulations.rans_formulation.RansFormulation.IsConverged

(

self

)

Recursively checks whether all formulations are converged.

    Returns:
        bool: True if all of them have converged, False if not

IsPeriodic()

def formulations.rans_formulation.RansFormulation.IsPeriodic

(

self

)

Checks whether current formulations are solved with periodic conditions.

    Returns:
        bool: True if Periodic, False if not

PrepareModelPart()

def formulations.rans_formulation.RansFormulation.PrepareModelPart

(

self

)

Recursively calls PrepareModelPart methods of existing formulations in this formulaton.

SetCommunicator()

def formulations.rans_formulation.RansFormulation.SetCommunicator	(		self,
			communicator
	)

Sets the communicator for MPI use.

SetConstants()

def formulations.rans_formulation.RansFormulation.SetConstants	(		self,
			settings
	)

Recursively sets constants in the formulations.

    Args:
        settings (Kratos.Parameters): Constants settings

SetIsPeriodic()

def formulations.rans_formulation.RansFormulation.SetIsPeriodic	(		self,
			value
	)

Sets periodicity recursively for all formulations.

    Args:
        value (bool): True if formulations needs to be Periodic, False otherwise

SetMaxCouplingIterations()

def formulations.rans_formulation.RansFormulation.SetMaxCouplingIterations	(		self,
			max_iterations
	)

Sets max coupling iterations.

    This is not done recursively because, there are some formulations which doesn't have coupling iterations.
    Each formulation needs to set this seperately if base class SolveCouplingStep is used.

    Args:
        max_iterations (int): Maximum number of coupling iterations to be done in the child formulations

SetTimeSchemeSettings()

def formulations.rans_formulation.RansFormulation.SetTimeSchemeSettings	(		self,
			settings
	)

Sets time scheme settings recursively for all formulations.

    Args:
        settings (Kratos.Parameters): Time scheme settings

SetWallFunctionSettings()

def formulations.rans_formulation.RansFormulation.SetWallFunctionSettings	(		self,
			settings
	)

SolveCouplingStep()

def formulations.rans_formulation.RansFormulation.SolveCouplingStep

(

self

)

Solves current formulation.

    This method recursively solves each formulation in the list of formulations.

    Returns:
        bool: True if solve is successfull, False if not

---

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

• /home/runner/work/Documentation/Documentation/master/applications/RANSApplication/python_scripts/formulations/rans_formulation.py