Specification of transport model interface. More...

#include <transport_operator_splitting.hh>

Inheritance diagram for TransportBase:

Collaboration diagram for TransportBase:

Classes
class	TransportEqData

Public Member Functions
	TransportBase (Mesh &mesh, const Input::Record in_rec)

virtual	~TransportBase ()

virtual void	set_velocity_field (const MH_DofHandler &dh)

MassBalance *	mass_balance ()
	Sets pointer to data of other equations. TODO: there should be also passed the sigma parameter between dimensions. More...

unsigned int	n_substances ()
	Returns number of trnasported substances. More...

vector< string > &	substance_names ()
	Returns reference to the vector of substnace names. More...

virtual void	set_concentration_vector (Vec &vec)

Public Member Functions inherited from AdvectionProcessBase
	AdvectionProcessBase (Mesh &mesh, const Input::Record in_rec)

Public Member Functions inherited from EquationBase
	EquationBase ()

	EquationBase (Mesh &mesh, const Input::Record in_rec)

virtual	~EquationBase ()

virtual void	zero_time_step ()

virtual void	update_solution ()

virtual void	initialize ()
	Initialize fields. More...

virtual void	choose_next_time ()

virtual void	set_time_upper_constraint (double dt)

virtual void	set_time_lower_constraint (double dt)

TimeGovernor const &	time ()

virtual void	set_time_governor (TimeGovernor &time)

double	planned_time ()

double	solved_time ()

Mesh &	mesh ()

TimeMark::Type	mark_type ()

FieldSet &	data ()

virtual void	get_solution_vector (double *&vector, unsigned int &size)

virtual void	get_parallel_solution_vector (Vec &vector)

virtual void	output_data ()
	Write computed fields. More...

Public Member Functions inherited from EquationForMassBalance
virtual	~EquationForMassBalance ()

virtual TimeIntegrationScheme	time_scheme ()=0
	Returns the time integration scheme of the equation. More...

Static Public Attributes
static Input::Type::Record	input_type_output_record

Static Public Attributes inherited from AdvectionProcessBase
static Input::Type::AbstractRecord	input_type
	Common specification of the input record for secondary equations. More...

Protected Member Functions
const RegionDB *	region_db ()
	Returns the region database. More...

Protected Attributes
unsigned int	n_subst_
	Number of transported substances. More...

std::vector< string >	subst_names_
	Names of transported substances. More...

const MH_DofHandler *	mh_dh

MassBalance *	mass_balance_
	object for calculation and writing the mass balance to file. More...

Additional Inherited Members
Public Types inherited from EquationForMassBalance
enum	TimeIntegrationScheme { none, explicit_euler, implicit_euler, crank_nicholson }

Detailed Description

Specification of transport model interface.

Here one has to specify methods for setting or getting data particular to transport equations.

Definition at line 70 of file transport_operator_splitting.hh.

Constructor & Destructor Documentation

TransportBase::TransportBase	(	Mesh &	mesh,
		const Input::Record	in_rec
	)

Definition at line 91 of file transport_operator_splitting.cc.

TransportBase::~TransportBase ( )

virtual

Definition at line 98 of file transport_operator_splitting.cc.

Member Function Documentation

MassBalance* TransportBase::mass_balance ( )

inline

Sets pointer to data of other equations. TODO: there should be also passed the sigma parameter between dimensions.

Parameters

cross_section is pointer to cross_section data of Darcy flow equation Getter for mass balance class

Definition at line 126 of file transport_operator_splitting.hh.

Here is the caller graph for this function:

unsigned int TransportBase::n_substances ( )

inlinevirtual

Returns number of trnasported substances.

Implements AdvectionProcessBase.

Definition at line 129 of file transport_operator_splitting.hh.

Here is the caller graph for this function:

const RegionDB* TransportBase::region_db ( )

inlineprotectedvirtual

Returns the region database.

Implements EquationForMassBalance.

Definition at line 140 of file transport_operator_splitting.hh.

virtual void TransportBase::set_concentration_vector ( Vec & vec)

inlinevirtual

Definition at line 134 of file transport_operator_splitting.hh.

virtual void TransportBase::set_velocity_field ( const MH_DofHandler & dh)

inlinevirtual

This method takes sequential PETSc vector of side velocities and update transport matrix. The ordering is same as ordering of sides in the mesh. We just keep the pointer, but do not destroy the object.

TODO: We should pass whole velocity field object (description of base functions and dof numbering) and vector.

Implements AdvectionProcessBase.

Reimplemented in TransportOperatorSplitting, and TransportDG< Model >.

Definition at line 110 of file transport_operator_splitting.hh.

Here is the caller graph for this function:

vector<string>& TransportBase::substance_names ( )

inlinevirtual

Returns reference to the vector of substnace names.

Implements AdvectionProcessBase.

Definition at line 132 of file transport_operator_splitting.hh.

Member Data Documentation

Record TransportBase::input_type_output_record

static

Initial value:

= Record("TransportOutput", "Output setting for transport equations.")
    .declare_key("output_stream", OutputTime::input_type, Default::obligatory(),
            "Parameters of output stream.")

Specification of the output record. Need not to be used by all transport models, but they should allow output of similar fields.

Definition at line 105 of file transport_operator_splitting.hh.

MassBalance* TransportBase::mass_balance_

protected

object for calculation and writing the mass balance to file.

Mark type mask that is true for time marks of output points of the transport model. E.g. for TransportOperatorSplitting this is same as the output points of its transport sub-model.

Definition at line 162 of file transport_operator_splitting.hh.

const MH_DofHandler* TransportBase::mh_dh

protected

Temporary solution how to pass velocity field form the flow model. TODO: introduce FieldDiscrete -containing true DOFHandler and data vector and pass such object together with other data. Possibly make more general set_data method, allowing setting data given by name. needs support from EqDataBase.

Definition at line 153 of file transport_operator_splitting.hh.

unsigned int TransportBase::n_subst_

protected

Number of transported substances.

Definition at line 143 of file transport_operator_splitting.hh.

std::vector<string> TransportBase::subst_names_

protected

Names of transported substances.

Definition at line 146 of file transport_operator_splitting.hh.

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