convection_diffusion_solver.ConvectionDiffusionSolver Class Reference

The base class for convection-diffusion solvers. More...

Inheritance diagram for convection_diffusion_solver.ConvectionDiffusionSolver:

Collaboration diagram for convection_diffusion_solver.ConvectionDiffusionSolver:

Public Member Functions
def	__init__ (self, model, custom_settings)
def	GetDefaultParameters (cls)
def	AddVariables (self, target_model_part=None)
def	GetMinimumBufferSize (self)
def	AddDofs (self)
def	GetDofsList (self)
	This function creates and returns a list with the DOFs defined in the Kratos parameters settings Note that element GetSpecifications method cannot be used in this case as DOF variables are a priori unknown. More...
def	ImportModelPart (self)
	This function imports the ModelPart. More...
def	PrepareModelPart (self)
def	Initialize (self)
	Perform initialization after adding nodal variables and dofs to the main model part. More...
def	GetOutputVariables (self)
def	Solve (self)
def	InitializeSolutionStep (self)
def	Predict (self)
def	SolveSolutionStep (self)
def	FinalizeSolutionStep (self)
def	AdvanceInTime (self, current_time)
def	ComputeDeltaTime (self)
def	GetComputingModelPart (self)
def	ExportModelPart (self)
def	SetEchoLevel (self, level)
def	Clear (self)
def	Check (self)
def	import_materials (self)
def	is_restarted (self)
def	get_epetra_communicator (self)

Public Attributes
	min_buffer_size
	main_model_part
	solver_imports_model_part
	distributed_model_part_importer

Detailed Description

The base class for convection-diffusion solvers.

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

Derived classes must override the function _CreateScheme which
constructs and returns a solution scheme. Depending on the type of
solver, derived classes may also need to override the following functions:

_CreateScheme
_CreateConvergenceCriterion
_CreateLinearSolver
_CreateBuilderAndSolver
_CreateSolutionStrategy

The convection_diffusion_solution_strategy, builder_and_solver, etc. should alway be retrieved
using the getter functions _GetSolutionStrategy, get_builder_and_solver,
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 convection_diffusion_solver.ConvectionDiffusionSolver.__init__	(		self,
			model,
			custom_settings
	)

Reimplemented in convection_diffusion_transient_solver.ConvectionDiffusionTransientSolver, convection_diffusion_semi_eulerian_solver.ConvectionDiffusionSemiImplicitSolver, convection_diffusion_explicit_solver.ConvectionDiffusionExplicitSolver, convection_diffusion_stationary_solver.ConvectionDiffusionStationarySolver, convection_diffusion_stationary_matrix_solver.ConvectionDiffusionStationaryMatrixSolver, and convection_diffusion_stationary_embedded_solver.ConvectionDiffusionStationaryEmbeddedSolver.

Member Function Documentation

AddDofs()

def convection_diffusion_solver.ConvectionDiffusionSolver.AddDofs

(

self

)

AddVariables()

def convection_diffusion_solver.ConvectionDiffusionSolver.AddVariables	(		self,
			target_model_part = None
	)

AdvanceInTime()

def convection_diffusion_solver.ConvectionDiffusionSolver.AdvanceInTime	(		self,
			current_time
	)

Check()

def convection_diffusion_solver.ConvectionDiffusionSolver.Check

(

self

)

Clear()

def convection_diffusion_solver.ConvectionDiffusionSolver.Clear

(

self

)

ComputeDeltaTime()

def convection_diffusion_solver.ConvectionDiffusionSolver.ComputeDeltaTime

(

self

)

ExportModelPart()

def convection_diffusion_solver.ConvectionDiffusionSolver.ExportModelPart

(

self

)

FinalizeSolutionStep()

def convection_diffusion_solver.ConvectionDiffusionSolver.FinalizeSolutionStep

(

self

)

get_epetra_communicator()

def convection_diffusion_solver.ConvectionDiffusionSolver.get_epetra_communicator

(

self

)

GetComputingModelPart()

def convection_diffusion_solver.ConvectionDiffusionSolver.GetComputingModelPart

(

self

)

GetDefaultParameters()

def convection_diffusion_solver.ConvectionDiffusionSolver.GetDefaultParameters

(

cls

)

Reimplemented in convection_diffusion_transient_solver.ConvectionDiffusionTransientSolver, convection_diffusion_stationary_embedded_solver.ConvectionDiffusionStationaryEmbeddedSolver, convection_diffusion_semi_eulerian_solver.ConvectionDiffusionSemiImplicitSolver, and convection_diffusion_explicit_solver.ConvectionDiffusionExplicitSolver.

GetDofsList()

def convection_diffusion_solver.ConvectionDiffusionSolver.GetDofsList

(

self

)

This function creates and returns a list with the DOFs defined in the Kratos parameters settings Note that element GetSpecifications method cannot be used in this case as DOF variables are a priori unknown.

GetMinimumBufferSize()

def convection_diffusion_solver.ConvectionDiffusionSolver.GetMinimumBufferSize

(

self

)

GetOutputVariables()

def convection_diffusion_solver.ConvectionDiffusionSolver.GetOutputVariables

(

self

)

import_materials()

def convection_diffusion_solver.ConvectionDiffusionSolver.import_materials

(

self

)

ImportModelPart()

def convection_diffusion_solver.ConvectionDiffusionSolver.ImportModelPart

(

self

)

This function imports the ModelPart.

Initialize()

def convection_diffusion_solver.ConvectionDiffusionSolver.Initialize

(

self

)

Perform initialization after adding nodal variables and dofs to the main model part.

Reimplemented in convection_diffusion_stationary_embedded_solver.ConvectionDiffusionStationaryEmbeddedSolver, convection_diffusion_semi_eulerian_solver.ConvectionDiffusionSemiImplicitSolver, and convection_diffusion_explicit_solver.ConvectionDiffusionExplicitSolver.

InitializeSolutionStep()

def convection_diffusion_solver.ConvectionDiffusionSolver.InitializeSolutionStep

(

self

)

is_restarted()

def convection_diffusion_solver.ConvectionDiffusionSolver.is_restarted

(

self

)

Predict()

def convection_diffusion_solver.ConvectionDiffusionSolver.Predict

(

self

)

PrepareModelPart()

def convection_diffusion_solver.ConvectionDiffusionSolver.PrepareModelPart

(

self

)

SetEchoLevel()

def convection_diffusion_solver.ConvectionDiffusionSolver.SetEchoLevel	(		self,
			level
	)

Solve()

def convection_diffusion_solver.ConvectionDiffusionSolver.Solve

(

self

)

SolveSolutionStep()

def convection_diffusion_solver.ConvectionDiffusionSolver.SolveSolutionStep

(

self

)

Reimplemented in convection_diffusion_stationary_matrix_solver.ConvectionDiffusionStationaryMatrixSolver, and convection_diffusion_semi_eulerian_solver.ConvectionDiffusionSemiImplicitSolver.

Member Data Documentation

distributed_model_part_importer

convection_diffusion_solver.ConvectionDiffusionSolver.distributed_model_part_importer

main_model_part

convection_diffusion_solver.ConvectionDiffusionSolver.main_model_part

min_buffer_size

convection_diffusion_solver.ConvectionDiffusionSolver.min_buffer_size

solver_imports_model_part

convection_diffusion_solver.ConvectionDiffusionSolver.solver_imports_model_part

---

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

• /home/runner/work/Documentation/Documentation/master/applications/ConvectionDiffusionApplication/python_scripts/convection_diffusion_solver.py