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.
Public Member Functions | Public Attributes | List of all members
fluid_solver.FluidSolver Class Reference

The base class for fluid dynamics solvers. More...

Inheritance diagram for fluid_solver.FluidSolver:
Collaboration diagram for fluid_solver.FluidSolver:

Public Member Functions

def __init__ (self, model, settings)
 
def AddVariables (self)
 
def AddDofs (self)
 
def GetDofsList (self)
 This function creates and returns a list with the DOFs defined in the conditions and elements specifications Note that this requires the main_model_part to be already set, that is to say to have already performed the element substitution (see PrepareModelPart). More...
 
def ImportModelPart (self)
 
def PrepareModelPart (self)
 
def ExportModelPart (self)
 
def GetMinimumBufferSize (self)
 
def Initialize (self)
 
def AdvanceInTime (self, current_time)
 
def InitializeSolutionStep (self)
 
def Predict (self)
 
def SolveSolutionStep (self)
 
def FinalizeSolutionStep (self)
 
def Check (self)
 
def Clear (self)
 
def GetComputingModelPart (self)
 
def is_restarted (self)
 
def GetEstimateDtUtility (self)
 

Public Attributes

 element_name
 Set the element and condition names for the replace settings These should be defined in derived classes. More...
 
 condition_name
 
 min_buffer_size
 
 main_model_part
 
 time_discretization
 

Detailed Description

The base class for fluid dynamics solvers.

This class provides functions for importing and exporting models,
adding nodal variables and dofs and solving each solution step.

Depending on the formulation type, derived classes may require to
override some (or all) the following functions:

_CreateScheme
_CreateConvergenceCriterion
_CreateLinearSolver
_CreateBuilderAndSolver
_CreateSolutionStrategy

The solution strategy, builder_and_solver, etc. should alway be retrieved
using the getter functions _GetSolutionStrategy, _GetBuilderAndSolver,
etc. from this base class.

Only the member variables listed below should be accessed directly.

Public member variables:
model -- the model containing the modelpart used to construct the solver.
settings -- Kratos parameters containing solver settings.

Constructor & Destructor Documentation

◆ __init__()

def fluid_solver.FluidSolver.__init__ (   self,
  model,
  settings 
)

Member Function Documentation

◆ AddDofs()

def fluid_solver.FluidSolver.AddDofs (   self)

◆ AddVariables()

def fluid_solver.FluidSolver.AddVariables (   self)

◆ AdvanceInTime()

def fluid_solver.FluidSolver.AdvanceInTime (   self,
  current_time 
)

◆ Check()

def fluid_solver.FluidSolver.Check (   self)

◆ Clear()

def fluid_solver.FluidSolver.Clear (   self)

◆ ExportModelPart()

def fluid_solver.FluidSolver.ExportModelPart (   self)

◆ FinalizeSolutionStep()

def fluid_solver.FluidSolver.FinalizeSolutionStep (   self)

◆ GetComputingModelPart()

def fluid_solver.FluidSolver.GetComputingModelPart (   self)

◆ GetDofsList()

def fluid_solver.FluidSolver.GetDofsList (   self)

This function creates and returns a list with the DOFs defined in the conditions and elements specifications Note that this requires the main_model_part to be already set, that is to say to have already performed the element substitution (see PrepareModelPart).

◆ GetEstimateDtUtility()

def fluid_solver.FluidSolver.GetEstimateDtUtility (   self)

◆ GetMinimumBufferSize()

def fluid_solver.FluidSolver.GetMinimumBufferSize (   self)

◆ ImportModelPart()

def fluid_solver.FluidSolver.ImportModelPart (   self)

◆ Initialize()

def fluid_solver.FluidSolver.Initialize (   self)

◆ InitializeSolutionStep()

def fluid_solver.FluidSolver.InitializeSolutionStep (   self)

◆ is_restarted()

def fluid_solver.FluidSolver.is_restarted (   self)

◆ Predict()

def fluid_solver.FluidSolver.Predict (   self)

◆ PrepareModelPart()

def fluid_solver.FluidSolver.PrepareModelPart (   self)

◆ SolveSolutionStep()

def fluid_solver.FluidSolver.SolveSolutionStep (   self)

Member Data Documentation

◆ condition_name

fluid_solver.FluidSolver.condition_name

◆ element_name

fluid_solver.FluidSolver.element_name

Set the element and condition names for the replace settings These should be defined in derived classes.

◆ main_model_part

fluid_solver.FluidSolver.main_model_part

◆ min_buffer_size

fluid_solver.FluidSolver.min_buffer_size

◆ time_discretization

fluid_solver.FluidSolver.time_discretization

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