Flow123d  3.9.1-0844c3d
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
SorptionBase::EqFields Class Reference

#include <sorption_base.hh>

Inheritance diagram for SorptionBase::EqFields:
Inheritance graph
[legend]
Collaboration diagram for SorptionBase::EqFields:
Collaboration graph
[legend]

Public Member Functions

 EqFields (const string &output_field_name, const string &output_field_desc)
 Collect all fields. More...
 
- Public Member Functions inherited from ReactionTerm::EqFields
 EqFields ()
 Constructor. More...
 
- Public Member Functions inherited from FieldSet
 DECLARE_EXCEPTION (ExcUnknownField,<< "Field set has no field with name: "<< FieldCommon::EI_Field::qval)
 
 DECLARE_INPUT_EXCEPTION (ExcFieldNotSet,<< "Field "<< FieldCommon::EI_Field::qval<< " is not set. Please set key 'scalar_field', 'vector_field' or 'tensor_field' at: \n")
 
 FieldSet ()
 Default constructor. More...
 
const Input::Type::Recordget_user_field (const std::string &equation_name)
 Declare input record type of field defined by user. More...
 
Input::Type::Record make_field_descriptor_type (const std::string &equation_name) const
 
void set_field (const std::string &dest_field_name, FieldCommon &source)
 
FieldCommonfield (const std::string &field_name) const
 
FieldCommonoperator[] (const std::string &field_name) const
 
void set_components (const std::vector< string > &names)
 
void set_mesh (const Mesh &mesh)
 
void set_input_list (Input::Array input_list, const TimeGovernor &tg)
 
void set_user_fields_map (Input::Array input_list)
 
void flags_add (FieldFlag::Flags::Mask mask)
 
bool set_time (const TimeStep &time, LimitSide limit_side)
 
void output_type (OutputTime::DiscreteSpace rt)
 
void mark_input_times (const TimeGovernor &tg)
 
bool changed () const
 
bool is_constant (Region reg) const
 
bool is_jump_time () const
 
void cache_reallocate (const ElementCacheMap &cache_map, FieldSet &used_fieldset)
 
void cache_update (ElementCacheMap &cache_map)
 
void set_dependency (FieldSet &used_fieldset)
 
void add_coords_field ()
 
void set_surface_depth (std::shared_ptr< SurfaceDepth > surface_depth)
 Set surface depth object to "d" field. More...
 
Range< FieldListAccessorfields_range () const
 Returns range of Fields held in field_list. More...
 
const Meshmesh () const
 Returns pointer to mesh. More...
 
std::string print_dependency () const
 Return order of evaluated fields by dependency and region_idx. More...
 
FieldCommonuser_field (const std::string &field_name, const TimeStep &time)
 

Static Public Member Functions

static const Input::Type::Selectionget_sorption_type_selection ()
 

Public Attributes

MultiField< 3, FieldValue< 3 >::Enum > sorption_type
 Discrete need Selection for initialization. More...
 
Field< 3, FieldValue< 3 >::Scalar > rock_density
 Rock matrix density. More...
 
MultiField< 3, FieldValue< 3 >::Scalar > distribution_coefficient
 Multiplication coefficients (k, omega) for all types of isotherms. More...
 
MultiField< 3, FieldValue< 3 >::Scalar > isotherm_other
 Langmuir sorption coeficients alpha (in fraction c_s = omega * (alpha*c_a)/(1- alpha*c_a)). More...
 
MultiField< 3, FieldValue< 3 >::Scalar > init_conc_solid
 Initial sorbed concentrations. More...
 
Field< 3, FieldValue< 3 >::Scalar > porosity
 Porosity field copied from transport. More...
 
MultiField< 3, FieldValue< 3 >::Scalar > conc_solid
 Calculated sorbed concentrations, for output only. More...
 
FieldFEScalarVec conc_solid_fe
 Underlaying FieldFE for each substance of conc_solid. More...
 
FieldSet input_field_set_
 Input data set - fields in this set are read from the input file. More...
 
EquationOutput output_fields
 Fields indended for output, i.e. all input fields plus those representing solution. More...
 
Field< 3, FieldValue< 3 >::Scalar > scale_aqua
 Instances of FieldModel used in assembly methods. More...
 
Field< 3, FieldValue< 3 >::Scalar > scale_sorbed
 
Field< 3, FieldValue< 3 >::Scalar > no_sorbing_surface_cond
 
- Public Attributes inherited from ReactionTerm::EqFields
FieldFEScalarVec conc_mobile_fe
 FieldFEs representing P0 interpolation of mobile concentration (passed from transport). More...
 

Additional Inherited Members

- Public Types inherited from FieldFlag
typedef FlagArray< FieldFlagFlags
 
typedef Flags::Mask Mask
 
- Static Public Attributes inherited from FieldFlag
static constexpr unsigned int flags_size_ = 3
 Number of bits used by Field itself. More...
 
static constexpr Mask equation_input {1 << 0}
 The field is data parameter of the owning equation. (default on) More...
 
static constexpr Mask declare_input {1 << 1}
 The field can be set from input. The key in input field descriptor is declared. (default on) More...
 
static constexpr Mask allow_output {1 << 2}
 The field can output. Is part of generated output selection. (default on) More...
 
static constexpr Mask input_copy = ~declare_input & equation_input
 
static constexpr Mask in_time_term {1 << 8}
 A field is part of time term of the equation. More...
 
static constexpr Mask in_main_matrix {1 << 9}
 A field is part of main "stiffness matrix" of the equation. More...
 
static constexpr Mask in_rhs {1 << 10}
 A field is part of the right hand side of the equation. More...
 
static constexpr Mask equation_result = allow_output & ~declare_input & ~equation_input
 Match result fields. These are never given by input or copy of input. More...
 
static constexpr Mask equation_external_output = allow_output & input_copy
 Match an output field, that can be also copy of other field. More...
 
- Protected Member Functions inherited from FieldSet
void topological_sort (const FieldCommon *f, unsigned int i_reg, std::unordered_set< const FieldCommon * > &used_fields)
 Helper method sort used fields by dependency. More...
 
- Protected Attributes inherited from FieldSet
std::vector< FieldCommon * > field_list
 List of all fields. More...
 
std::vector< FieldCommon * > user_field_list_
 List of fields defined by user. More...
 
const Meshmesh_
 Pointer to the mesh. More...
 
std::map< unsigned int, std::vector< const FieldCommon * > > region_field_update_order_
 
FieldCoords X_
 Field holds coordinates for computing of FieldFormulas. More...
 
FieldDepth depth_
 Field holds surface depth for computing of FieldFormulas. More...
 
std::unordered_map< std::string, Input::Recorduser_fields_input_
 Map assigns Input::Record to each field defined in optional Input::Array 'user_fields'. More...
 

Detailed Description

Definition at line 83 of file sorption_base.hh.

Constructor & Destructor Documentation

◆ EqFields()

SorptionBase::EqFields::EqFields ( const string &  output_field_name,
const string &  output_field_desc 
)

Collect all fields.

Definition at line 79 of file sorption_base.cc.

Member Function Documentation

◆ get_sorption_type_selection()

const Selection & SorptionBase::EqFields::get_sorption_type_selection ( )
static

Sorption type specifies a kind of equilibrial description of adsorption.

Definition at line 41 of file sorption_base.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ conc_solid

MultiField<3, FieldValue<3>::Scalar> SorptionBase::EqFields::conc_solid

Calculated sorbed concentrations, for output only.

Definition at line 106 of file sorption_base.hh.

◆ conc_solid_fe

FieldFEScalarVec SorptionBase::EqFields::conc_solid_fe

Underlaying FieldFE for each substance of conc_solid.

Definition at line 107 of file sorption_base.hh.

◆ distribution_coefficient

MultiField<3, FieldValue<3>::Scalar > SorptionBase::EqFields::distribution_coefficient

Multiplication coefficients (k, omega) for all types of isotherms.

Langmuir: c_s = omega * (alpha*c_a)/(1- alpha*c_a), Linear: c_s = k*c_a

Definition at line 99 of file sorption_base.hh.

◆ init_conc_solid

MultiField<3, FieldValue<3>::Scalar> SorptionBase::EqFields::init_conc_solid

Initial sorbed concentrations.

Definition at line 103 of file sorption_base.hh.

◆ input_field_set_

FieldSet SorptionBase::EqFields::input_field_set_

Input data set - fields in this set are read from the input file.

Definition at line 110 of file sorption_base.hh.

◆ isotherm_other

MultiField<3, FieldValue<3>::Scalar > SorptionBase::EqFields::isotherm_other

Langmuir sorption coeficients alpha (in fraction c_s = omega * (alpha*c_a)/(1- alpha*c_a)).

Definition at line 101 of file sorption_base.hh.

◆ no_sorbing_surface_cond

Field<3, FieldValue<3>::Scalar > SorptionBase::EqFields::no_sorbing_surface_cond

Definition at line 118 of file sorption_base.hh.

◆ output_fields

EquationOutput SorptionBase::EqFields::output_fields

Fields indended for output, i.e. all input fields plus those representing solution.

Definition at line 113 of file sorption_base.hh.

◆ porosity

Field<3, FieldValue<3>::Scalar > SorptionBase::EqFields::porosity

Porosity field copied from transport.

Definition at line 104 of file sorption_base.hh.

◆ rock_density

Field<3, FieldValue<3>::Scalar > SorptionBase::EqFields::rock_density

Rock matrix density.

Definition at line 95 of file sorption_base.hh.

◆ scale_aqua

Field<3, FieldValue<3>::Scalar > SorptionBase::EqFields::scale_aqua

Instances of FieldModel used in assembly methods.

Definition at line 116 of file sorption_base.hh.

◆ scale_sorbed

Field<3, FieldValue<3>::Scalar > SorptionBase::EqFields::scale_sorbed

Definition at line 117 of file sorption_base.hh.

◆ sorption_type

MultiField<3, FieldValue<3>::Enum > SorptionBase::EqFields::sorption_type

Discrete need Selection for initialization.

Definition at line 94 of file sorption_base.hh.


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